Odoo Community Association

Automation Oca

Beta License: AGPL-3 OCA/automation Translate me on Weblate Try me on Runboat

This module allows to automate several process according to some rules.

This is useful for creating automated actions on your database like:

Table of contents

Use Cases / Context

Odoo core provides base_automation, which is well suited for simple, isolated rules triggered by internal record changes (e.g. on create, on update, on delete, or timed conditions).

When processes become more complex (multiple steps, different timings, conditional paths), it can be harder to understand and maintain the whole flow in base_automation.

automation_oca focuses on workflow-based automations, where the full process is defined as a sequence of steps with timings and dependencies, and can also react to external events such as email interactions (opened, replied, clicked, bounced, etc).

In short:

  • use ``base_automation`` for simple automations driven by internal record updates
  • use ``automation_oca`` for multi-step workflows with timings, dependencies, and external events

Usage

Configure your processes

  1. Access the Automation menu.
  2. Create a new Automation Configuration.
  3. Set the model and domains.
  4. Go to Configuration -> Filters to create filters as a preconfigured domains. Filters can be established in the proper field in the Automation Configuration record.
  5. Create the different steps by clicking the “ADD” button inside the automation configuration form.
  6. Create child steps by clicking the “Add child activity” at the bottom of a created step.
  8. Select the kind of configuration you create. You can choose between:
    • Periodic configurations: every 6 hours, a process will check if new records need to be created.
    • On demand configurations: user need to execute manually the job.
  9. Press Start.
  10. Inside the process, you can check all the created items.

Configuration Screenshot

Configuration of steps

Steps can trigger one of the following options:

  • Mail: Sends an email using a template.
  • Server Action: Executes a server action.
  • Activity: Creates an activity to the related record.

All the steps need to specify the moment of execution. We will set the number of hours/days and a trigger type:

  • Start of workflow: It will be executed at the previously-configured time after we create the record.
  • Execution of another step: It will be executed at the previously-configured time after the previous step is finished properly.
  • Mail opened: It will be executed at the previously-configured time after the mail from the previous step is opened.
  • Mail not opened: It will be executed at the previously-configured time after the mail from the previous step is sent if it is not opened before this time.
  • Mail replied: It will be executed at the previously-configured time after the mail from the previous step is replied.
  • Mail not replied: It will be executed at the previously-configured time after the mail from the previous step is opened if it has not been replied.
  • Mail clicked: It will be executed at the previously-configured time after the links of the mail from the previous step are clicked.
  • Mail not clicked: It will be executed at the previously-configured time after the mail from the previous step is opened and no links are clicked.
  • Mail bounced: It will be executed at the previously-configured time after the mail from the previous step is bounced back for any reason.
  • Activity has been finished: It will be executed at the previously-configured time after the activity from the previous action is done.
  • Activity has not been finished: It will be executed at the previously-configured time after the previous action is executed if the related activity is not done.

Important to remember to define a proper template when sending the email. It will the template without using a notification template. Also, it is important to define correctly the text partner or email to field on the template

Records creation

Records are created using a cron action. This action is executed every 6 hours by default.

Step execution

Steps are executed using a cron action. This action is executed every hour by default. On the record view, you can execute manually an action.

There is a way to enforce step execution when finalize the previous one. If we set a negative value on the period, the execution will be immediate without a cron.

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • Dixmit

Contributors

Other credits

The development of this module has been financially supported by:

  • Associacion Española de Odoo (AEODOO)

Maintainers

This module is maintained by the OCA.

Odoo Community Association

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

This module is part of the OCA/automation project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.