mirror of
https://github.com/bringout/oca-technical.git
synced 2026-04-21 03:52:03 +02:00
539 lines
18 KiB
HTML
539 lines
18 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
|
|
<title>README.rst</title>
|
|
<style type="text/css">
|
|
|
|
/*
|
|
:Author: David Goodger (goodger@python.org)
|
|
:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
|
|
:Copyright: This stylesheet has been placed in the public domain.
|
|
|
|
Default cascading style sheet for the HTML output of Docutils.
|
|
Despite the name, some widely supported CSS2 features are used.
|
|
|
|
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
|
|
customize this style sheet.
|
|
*/
|
|
|
|
/* used to remove borders from tables and images */
|
|
.borderless, table.borderless td, table.borderless th {
|
|
border: 0 }
|
|
|
|
table.borderless td, table.borderless th {
|
|
/* Override padding for "table.docutils td" with "! important".
|
|
The right padding separates the table cells. */
|
|
padding: 0 0.5em 0 0 ! important }
|
|
|
|
.first {
|
|
/* Override more specific margin styles with "! important". */
|
|
margin-top: 0 ! important }
|
|
|
|
.last, .with-subtitle {
|
|
margin-bottom: 0 ! important }
|
|
|
|
.hidden {
|
|
display: none }
|
|
|
|
.subscript {
|
|
vertical-align: sub;
|
|
font-size: smaller }
|
|
|
|
.superscript {
|
|
vertical-align: super;
|
|
font-size: smaller }
|
|
|
|
a.toc-backref {
|
|
text-decoration: none ;
|
|
color: black }
|
|
|
|
blockquote.epigraph {
|
|
margin: 2em 5em ; }
|
|
|
|
dl.docutils dd {
|
|
margin-bottom: 0.5em }
|
|
|
|
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
|
|
overflow: hidden;
|
|
}
|
|
|
|
/* Uncomment (and remove this text!) to get bold-faced definition list terms
|
|
dl.docutils dt {
|
|
font-weight: bold }
|
|
*/
|
|
|
|
div.abstract {
|
|
margin: 2em 5em }
|
|
|
|
div.abstract p.topic-title {
|
|
font-weight: bold ;
|
|
text-align: center }
|
|
|
|
div.admonition, div.attention, div.caution, div.danger, div.error,
|
|
div.hint, div.important, div.note, div.tip, div.warning {
|
|
margin: 2em ;
|
|
border: medium outset ;
|
|
padding: 1em }
|
|
|
|
div.admonition p.admonition-title, div.hint p.admonition-title,
|
|
div.important p.admonition-title, div.note p.admonition-title,
|
|
div.tip p.admonition-title {
|
|
font-weight: bold ;
|
|
font-family: sans-serif }
|
|
|
|
div.attention p.admonition-title, div.caution p.admonition-title,
|
|
div.danger p.admonition-title, div.error p.admonition-title,
|
|
div.warning p.admonition-title, .code .error {
|
|
color: red ;
|
|
font-weight: bold ;
|
|
font-family: sans-serif }
|
|
|
|
/* Uncomment (and remove this text!) to get reduced vertical space in
|
|
compound paragraphs.
|
|
div.compound .compound-first, div.compound .compound-middle {
|
|
margin-bottom: 0.5em }
|
|
|
|
div.compound .compound-last, div.compound .compound-middle {
|
|
margin-top: 0.5em }
|
|
*/
|
|
|
|
div.dedication {
|
|
margin: 2em 5em ;
|
|
text-align: center ;
|
|
font-style: italic }
|
|
|
|
div.dedication p.topic-title {
|
|
font-weight: bold ;
|
|
font-style: normal }
|
|
|
|
div.figure {
|
|
margin-left: 2em ;
|
|
margin-right: 2em }
|
|
|
|
div.footer, div.header {
|
|
clear: both;
|
|
font-size: smaller }
|
|
|
|
div.line-block {
|
|
display: block ;
|
|
margin-top: 1em ;
|
|
margin-bottom: 1em }
|
|
|
|
div.line-block div.line-block {
|
|
margin-top: 0 ;
|
|
margin-bottom: 0 ;
|
|
margin-left: 1.5em }
|
|
|
|
div.sidebar {
|
|
margin: 0 0 0.5em 1em ;
|
|
border: medium outset ;
|
|
padding: 1em ;
|
|
background-color: #ffffee ;
|
|
width: 40% ;
|
|
float: right ;
|
|
clear: right }
|
|
|
|
div.sidebar p.rubric {
|
|
font-family: sans-serif ;
|
|
font-size: medium }
|
|
|
|
div.system-messages {
|
|
margin: 5em }
|
|
|
|
div.system-messages h1 {
|
|
color: red }
|
|
|
|
div.system-message {
|
|
border: medium outset ;
|
|
padding: 1em }
|
|
|
|
div.system-message p.system-message-title {
|
|
color: red ;
|
|
font-weight: bold }
|
|
|
|
div.topic {
|
|
margin: 2em }
|
|
|
|
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
|
|
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
|
|
margin-top: 0.4em }
|
|
|
|
h1.title {
|
|
text-align: center }
|
|
|
|
h2.subtitle {
|
|
text-align: center }
|
|
|
|
hr.docutils {
|
|
width: 75% }
|
|
|
|
img.align-left, .figure.align-left, object.align-left, table.align-left {
|
|
clear: left ;
|
|
float: left ;
|
|
margin-right: 1em }
|
|
|
|
img.align-right, .figure.align-right, object.align-right, table.align-right {
|
|
clear: right ;
|
|
float: right ;
|
|
margin-left: 1em }
|
|
|
|
img.align-center, .figure.align-center, object.align-center {
|
|
display: block;
|
|
margin-left: auto;
|
|
margin-right: auto;
|
|
}
|
|
|
|
table.align-center {
|
|
margin-left: auto;
|
|
margin-right: auto;
|
|
}
|
|
|
|
.align-left {
|
|
text-align: left }
|
|
|
|
.align-center {
|
|
clear: both ;
|
|
text-align: center }
|
|
|
|
.align-right {
|
|
text-align: right }
|
|
|
|
/* reset inner alignment in figures */
|
|
div.align-right {
|
|
text-align: inherit }
|
|
|
|
/* div.align-center * { */
|
|
/* text-align: left } */
|
|
|
|
.align-top {
|
|
vertical-align: top }
|
|
|
|
.align-middle {
|
|
vertical-align: middle }
|
|
|
|
.align-bottom {
|
|
vertical-align: bottom }
|
|
|
|
ol.simple, ul.simple {
|
|
margin-bottom: 1em }
|
|
|
|
ol.arabic {
|
|
list-style: decimal }
|
|
|
|
ol.loweralpha {
|
|
list-style: lower-alpha }
|
|
|
|
ol.upperalpha {
|
|
list-style: upper-alpha }
|
|
|
|
ol.lowerroman {
|
|
list-style: lower-roman }
|
|
|
|
ol.upperroman {
|
|
list-style: upper-roman }
|
|
|
|
p.attribution {
|
|
text-align: right ;
|
|
margin-left: 50% }
|
|
|
|
p.caption {
|
|
font-style: italic }
|
|
|
|
p.credits {
|
|
font-style: italic ;
|
|
font-size: smaller }
|
|
|
|
p.label {
|
|
white-space: nowrap }
|
|
|
|
p.rubric {
|
|
font-weight: bold ;
|
|
font-size: larger ;
|
|
color: maroon ;
|
|
text-align: center }
|
|
|
|
p.sidebar-title {
|
|
font-family: sans-serif ;
|
|
font-weight: bold ;
|
|
font-size: larger }
|
|
|
|
p.sidebar-subtitle {
|
|
font-family: sans-serif ;
|
|
font-weight: bold }
|
|
|
|
p.topic-title {
|
|
font-weight: bold }
|
|
|
|
pre.address {
|
|
margin-bottom: 0 ;
|
|
margin-top: 0 ;
|
|
font: inherit }
|
|
|
|
pre.literal-block, pre.doctest-block, pre.math, pre.code {
|
|
margin-left: 2em ;
|
|
margin-right: 2em }
|
|
|
|
pre.code .ln { color: gray; } /* line numbers */
|
|
pre.code, code { background-color: #eeeeee }
|
|
pre.code .comment, code .comment { color: #5C6576 }
|
|
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
|
|
pre.code .literal.string, code .literal.string { color: #0C5404 }
|
|
pre.code .name.builtin, code .name.builtin { color: #352B84 }
|
|
pre.code .deleted, code .deleted { background-color: #DEB0A1}
|
|
pre.code .inserted, code .inserted { background-color: #A3D289}
|
|
|
|
span.classifier {
|
|
font-family: sans-serif ;
|
|
font-style: oblique }
|
|
|
|
span.classifier-delimiter {
|
|
font-family: sans-serif ;
|
|
font-weight: bold }
|
|
|
|
span.interpreted {
|
|
font-family: sans-serif }
|
|
|
|
span.option {
|
|
white-space: nowrap }
|
|
|
|
span.pre {
|
|
white-space: pre }
|
|
|
|
span.problematic, pre.problematic {
|
|
color: red }
|
|
|
|
span.section-subtitle {
|
|
/* font-size relative to parent (h1..h6 element) */
|
|
font-size: 80% }
|
|
|
|
table.citation {
|
|
border-left: solid 1px gray;
|
|
margin-left: 1px }
|
|
|
|
table.docinfo {
|
|
margin: 2em 4em }
|
|
|
|
table.docutils {
|
|
margin-top: 0.5em ;
|
|
margin-bottom: 0.5em }
|
|
|
|
table.footnote {
|
|
border-left: solid 1px black;
|
|
margin-left: 1px }
|
|
|
|
table.docutils td, table.docutils th,
|
|
table.docinfo td, table.docinfo th {
|
|
padding-left: 0.5em ;
|
|
padding-right: 0.5em ;
|
|
vertical-align: top }
|
|
|
|
table.docutils th.field-name, table.docinfo th.docinfo-name {
|
|
font-weight: bold ;
|
|
text-align: left ;
|
|
white-space: nowrap ;
|
|
padding-left: 0 }
|
|
|
|
/* "booktabs" style (no vertical lines) */
|
|
table.docutils.booktabs {
|
|
border: 0px;
|
|
border-top: 2px solid;
|
|
border-bottom: 2px solid;
|
|
border-collapse: collapse;
|
|
}
|
|
table.docutils.booktabs * {
|
|
border: 0px;
|
|
}
|
|
table.docutils.booktabs th {
|
|
border-bottom: thin solid;
|
|
text-align: left;
|
|
}
|
|
|
|
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
|
|
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
|
|
font-size: 100% }
|
|
|
|
ul.auto-toc {
|
|
list-style-type: none }
|
|
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<div class="document">
|
|
|
|
|
|
<a class="reference external image-reference" href="https://odoo-community.org/get-involved?utm_source=readme">
|
|
<img alt="Odoo Community Association" src="https://odoo-community.org/readme-banner-image" />
|
|
</a>
|
|
<div class="section" id="automation-oca">
|
|
<h1>Automation Oca</h1>
|
|
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! This file is generated by oca-gen-addon-readme !!
|
|
!! changes will be overwritten. !!
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! source digest: sha256:bf7f94a060a16c6d36248bb970d9cbc5925480da1127a49bfb77208b1a1821e5
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
|
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/license-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/automation/tree/16.0/automation_oca"><img alt="OCA/automation" src="https://img.shields.io/badge/github-OCA%2Fautomation-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/automation-16-0/automation-16-0-automation_oca"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/automation&target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
|
|
<p>This module allows to automate several process according to some rules.</p>
|
|
<p>This is useful for creating automated actions on your database like:</p>
|
|
<ul class="simple">
|
|
<li>Send a welcome email to all new partners (or filtered according to
|
|
some rules)</li>
|
|
<li>Remember to online customers that they forgot their basket with some
|
|
items</li>
|
|
<li>Send documents to sign to all new employees</li>
|
|
</ul>
|
|
<p><strong>Table of contents</strong></p>
|
|
<div class="contents local topic" id="contents">
|
|
<ul class="simple">
|
|
<li><a class="reference internal" href="#usage" id="toc-entry-1">Usage</a><ul>
|
|
<li><a class="reference internal" href="#configure-your-processes" id="toc-entry-2">Configure your processes</a></li>
|
|
<li><a class="reference internal" href="#configuration-of-steps" id="toc-entry-3">Configuration of steps</a></li>
|
|
<li><a class="reference internal" href="#records-creation" id="toc-entry-4">Records creation</a></li>
|
|
<li><a class="reference internal" href="#step-execution" id="toc-entry-5">Step execution</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-6">Bug Tracker</a></li>
|
|
<li><a class="reference internal" href="#credits" id="toc-entry-7">Credits</a><ul>
|
|
<li><a class="reference internal" href="#authors" id="toc-entry-8">Authors</a></li>
|
|
<li><a class="reference internal" href="#contributors" id="toc-entry-9">Contributors</a></li>
|
|
<li><a class="reference internal" href="#other-credits" id="toc-entry-10">Other credits</a></li>
|
|
<li><a class="reference internal" href="#maintainers" id="toc-entry-11">Maintainers</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="usage">
|
|
<h2><a class="toc-backref" href="#toc-entry-1">Usage</a></h2>
|
|
<div class="section" id="configure-your-processes">
|
|
<h3><a class="toc-backref" href="#toc-entry-2">Configure your processes</a></h3>
|
|
<ol class="arabic simple">
|
|
<li>Access the <tt class="docutils literal">Automation</tt> menu.</li>
|
|
<li>Create a new Automation Configuration.</li>
|
|
<li>Set the model and domains.</li>
|
|
<li>Go to Configuration -> Filters to create filters as a preconfigured
|
|
domains. Filters can be established in the proper field in the
|
|
Automation Configuration record.</li>
|
|
<li>Create the different steps by clicking the “ADD” button inside the
|
|
automation configuration form.</li>
|
|
<li>Create child steps by clicking the “Add child activity” at the
|
|
bottom of a created step.</li>
|
|
<li></li>
|
|
<li>Select the kind of configuration you create. You can choose between:<ul>
|
|
<li><em>Periodic configurations</em>: every 6 hours, a process will check if
|
|
new records need to be created.</li>
|
|
<li><em>On demand configurations</em>: user need to execute manually the job.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Press <tt class="docutils literal">Start</tt>.</li>
|
|
<li>Inside the process, you can check all the created items.</li>
|
|
</ol>
|
|
<p><img alt="Configuration Screenshot" src="https://raw.githubusercontent.com/OCA/automation/16.0/automation_oca/static/description/configuration.png" /></p>
|
|
</div>
|
|
<div class="section" id="configuration-of-steps">
|
|
<h3><a class="toc-backref" href="#toc-entry-3">Configuration of steps</a></h3>
|
|
<p>Steps can trigger one of the following options:</p>
|
|
<ul class="simple">
|
|
<li><tt class="docutils literal">Mail</tt>: Sends an email using a template.</li>
|
|
<li><tt class="docutils literal">Server Action</tt>: Executes a server action.</li>
|
|
<li><tt class="docutils literal">Activity</tt>: Creates an activity to the related record.</li>
|
|
</ul>
|
|
<p>All the steps need to specify the moment of execution. We will set the
|
|
number of hours/days and a trigger type:</p>
|
|
<ul class="simple">
|
|
<li><tt class="docutils literal">Start of workflow</tt>: It will be executed at the
|
|
previously-configured time after we create the record.</li>
|
|
<li><tt class="docutils literal">Execution of another step</tt>: It will be executed at the
|
|
previously-configured time after the previous step is finished
|
|
properly.</li>
|
|
<li><tt class="docutils literal">Mail opened</tt>: It will be executed at the previously-configured time
|
|
after the mail from the previous step is opened.</li>
|
|
<li><tt class="docutils literal">Mail not opened</tt>: 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.</li>
|
|
<li><tt class="docutils literal">Mail replied</tt>: It will be executed at the previously-configured
|
|
time after the mail from the previous step is replied.</li>
|
|
<li><tt class="docutils literal">Mail not replied</tt>: It will be executed at the previously-configured
|
|
time after the mail from the previous step is opened if it has not
|
|
been replied.</li>
|
|
<li><tt class="docutils literal">Mail clicked</tt>: It will be executed at the previously-configured
|
|
time after the links of the mail from the previous step are clicked.</li>
|
|
<li><tt class="docutils literal">Mail not clicked</tt>: It will be executed at the previously-configured
|
|
time after the mail from the previous step is opened and no links are
|
|
clicked.</li>
|
|
<li><tt class="docutils literal">Mail bounced</tt>: It will be executed at the previously-configured
|
|
time after the mail from the previous step is bounced back for any
|
|
reason.</li>
|
|
<li><tt class="docutils literal">Activity has been finished</tt>: It will be executed at the
|
|
previously-configured time after the activity from the previous action
|
|
is done.</li>
|
|
<li><tt class="docutils literal">Activity has not been finished</tt>: It will be executed at the
|
|
previously-configured time after the previous action is executed if
|
|
the related activity is not done.</li>
|
|
</ul>
|
|
<p>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</p>
|
|
</div>
|
|
<div class="section" id="records-creation">
|
|
<h3><a class="toc-backref" href="#toc-entry-4">Records creation</a></h3>
|
|
<p>Records are created using a cron action. This action is executed every 6
|
|
hours by default.</p>
|
|
</div>
|
|
<div class="section" id="step-execution">
|
|
<h3><a class="toc-backref" href="#toc-entry-5">Step execution</a></h3>
|
|
<p>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.</p>
|
|
<p>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.</p>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="bug-tracker">
|
|
<h2><a class="toc-backref" href="#toc-entry-6">Bug Tracker</a></h2>
|
|
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/automation/issues">GitHub Issues</a>.
|
|
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
|
|
<a class="reference external" href="https://github.com/OCA/automation/issues/new?body=module:%20automation_oca%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
|
|
<p>Do not contact contributors directly about support or help with technical issues.</p>
|
|
</div>
|
|
<div class="section" id="credits">
|
|
<h2><a class="toc-backref" href="#toc-entry-7">Credits</a></h2>
|
|
<div class="section" id="authors">
|
|
<h3><a class="toc-backref" href="#toc-entry-8">Authors</a></h3>
|
|
<ul class="simple">
|
|
<li>Dixmit</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="contributors">
|
|
<h3><a class="toc-backref" href="#toc-entry-9">Contributors</a></h3>
|
|
<ul class="simple">
|
|
<li>Enric Tobella (<a class="reference external" href="https://www.dixmit.com/">Dixmit</a>)</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="other-credits">
|
|
<h3><a class="toc-backref" href="#toc-entry-10">Other credits</a></h3>
|
|
<p>The development of this module has been financially supported by:</p>
|
|
<ul class="simple">
|
|
<li>Associacion Española de Odoo (<a class="reference external" href="https://www.aeodoo.org/">AEODOO</a>)</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="maintainers">
|
|
<h3><a class="toc-backref" href="#toc-entry-11">Maintainers</a></h3>
|
|
<p>This module is maintained by the OCA.</p>
|
|
<a class="reference external image-reference" href="https://odoo-community.org">
|
|
<img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
|
|
</a>
|
|
<p>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.</p>
|
|
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/automation/tree/16.0/automation_oca">OCA/automation</a> project on GitHub.</p>
|
|
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|