diff --git a/doc/guides/workflow/Makefile b/doc/guides/workflow/Makefile new file mode 100644 index 00000000000..07bbb67dd55 --- /dev/null +++ b/doc/guides/workflow/Makefile @@ -0,0 +1,20 @@ +DOTFILES:=$(wildcard *.dot) +SVGFILES:=$(patsubst %.dot,%.svg,$(DOTFILES)) +PNGFILES:=$(patsubst %.dot,%.png,$(DOTFILES)) + +# try to disable implicit rules +.SUFFIXES: + +.PHONY: all clean + +all: $(SVGFILES) $(PNGFILES) + +# must -f to ignore errors when running clean multiple times in a row +clean: + rm -f *.png *.svg + +%.svg: %.dot + dot -Tsvg $< > $@ + +%.png: %.dot + dot -Tpng $< > $@ diff --git a/doc/guides/workflow/join.dot b/doc/guides/workflow/join.dot new file mode 100644 index 00000000000..e413a8a8ebc --- /dev/null +++ b/doc/guides/workflow/join.dot @@ -0,0 +1,10 @@ +digraph join { + // dummy sources as support for edges, make invisible and height 0 + a [style=invis height=0 fontsize=0] + b [style=invis height=0 fontsize=0] + c [style=invis height=0 fontsize=0] + + a -> Activity + b -> Activity + c -> Activity +} diff --git a/doc/guides/workflow/join.png b/doc/guides/workflow/join.png new file mode 100644 index 00000000000..c63e97c809d Binary files /dev/null and b/doc/guides/workflow/join.png differ diff --git a/doc/guides/workflow/join.svg b/doc/guides/workflow/join.svg new file mode 100644 index 00000000000..1462281977f --- /dev/null +++ b/doc/guides/workflow/join.svg @@ -0,0 +1,36 @@ + + + + + + +join + + + +Activity + +Activity + + +a->Activity + + + + + +b->Activity + + + + + +c->Activity + + + + + diff --git a/doc/guides/workflow/order_0.dot b/doc/guides/workflow/order_0.dot new file mode 100644 index 00000000000..3932040e914 --- /dev/null +++ b/doc/guides/workflow/order_0.dot @@ -0,0 +1,9 @@ +digraph order { + Draft [style=filled fillcolor="#73fa79"] + Closed [style=filled fillcolor="#98c7df"] + Canceled [style=filled fillcolor="#98c7df"] + + Draft -> Confirmed + Confirmed -> Closed + Confirmed -> Canceled +} diff --git a/doc/guides/workflow/order_0.png b/doc/guides/workflow/order_0.png new file mode 100644 index 00000000000..98b552da1ba Binary files /dev/null and b/doc/guides/workflow/order_0.png differ diff --git a/doc/guides/workflow/order_0.svg b/doc/guides/workflow/order_0.svg new file mode 100644 index 00000000000..54a5c050238 --- /dev/null +++ b/doc/guides/workflow/order_0.svg @@ -0,0 +1,48 @@ + + + + + + +order + + +Draft + +Draft + + +Confirmed + +Confirmed + + +Draft->Confirmed + + + + +Closed + +Closed + + +Canceled + +Canceled + + +Confirmed->Closed + + + + +Confirmed->Canceled + + + + + diff --git a/doc/guides/workflow/order_1.dot b/doc/guides/workflow/order_1.dot new file mode 100644 index 00000000000..cc204343172 --- /dev/null +++ b/doc/guides/workflow/order_1.dot @@ -0,0 +1,11 @@ +digraph order { + Draft [style=filled fillcolor="#73fa79"] + Closed [style=filled fillcolor="#98c7df"] + Canceled [style=filled fillcolor="#98c7df"] + + Draft -> Confirmed [label="discount <= 15%"] + Draft -> Validation [label="discount > 15%"] + Validation -> Confirmed [label="Accept"] + Confirmed -> Closed + Confirmed -> Canceled +} diff --git a/doc/guides/workflow/order_1.png b/doc/guides/workflow/order_1.png new file mode 100644 index 00000000000..9aba2211022 Binary files /dev/null and b/doc/guides/workflow/order_1.png differ diff --git a/doc/guides/workflow/order_1.svg b/doc/guides/workflow/order_1.svg new file mode 100644 index 00000000000..08f099e34c9 --- /dev/null +++ b/doc/guides/workflow/order_1.svg @@ -0,0 +1,66 @@ + + + + + + +order + + +Draft + +Draft + + +Confirmed + +Confirmed + + +Draft->Confirmed + + +discount <= 15% + + +Validation + +Validation + + +Draft->Validation + + +discount > 15% + + +Closed + +Closed + + +Canceled + +Canceled + + +Confirmed->Closed + + + + +Confirmed->Canceled + + + + +Validation->Confirmed + + +Accept + + + diff --git a/doc/guides/workflow/split.dot b/doc/guides/workflow/split.dot new file mode 100644 index 00000000000..b0f3831854a --- /dev/null +++ b/doc/guides/workflow/split.dot @@ -0,0 +1,10 @@ +digraph split { + // dummy destinations as support for edges, make invisible and height 0 + a [style=invis height=0 fontsize=0] + b [style=invis height=0 fontsize=0] + c [style=invis height=0 fontsize=0] + + Activity -> a + Activity -> b + Activity -> c +} diff --git a/doc/guides/workflow/split.png b/doc/guides/workflow/split.png new file mode 100644 index 00000000000..329854a656b Binary files /dev/null and b/doc/guides/workflow/split.png differ diff --git a/doc/guides/workflow/split.svg b/doc/guides/workflow/split.svg new file mode 100644 index 00000000000..139874fdc75 --- /dev/null +++ b/doc/guides/workflow/split.svg @@ -0,0 +1,36 @@ + + + + + + +split + + + + + +Activity + +Activity + + +Activity->a + + + + +Activity->b + + + + +Activity->c + + + + + diff --git a/doc/guides/workflows.rst b/doc/guides/workflows.rst index 05957fce61b..24a79862e2e 100644 --- a/doc/guides/workflows.rst +++ b/doc/guides/workflows.rst @@ -3,14 +3,14 @@ Workflows ========= -In OpenERP, a workflow is a technical artefact to manage a set of "things to -do" associated to the records of some data model. The workflow provides a -higher- level way to organize the things to do on a record. +In Odoo, a workflow is a technical artefact to manage a set of "things to +do" associated to the records of a model. The workflow provides a higher-level +way to organize tasks to perform with or on a record. More specifically, a workflow is a directed graph where the nodes are called "activities" and the arcs are called "transitions". -- Activities define work that should be done within the OpenERP server, such +- Activities define work that should be done within the Odoo server, such as changing the state of some records, or sending emails. - Transitions control how the workflow progresses from activity to activity. @@ -19,6 +19,40 @@ triggers to transitions, so that the behavior of the workflow depends on user actions (such as clicking on a button), changes to records, or arbitrary Python code. +All in all, Odoo's workflow system provides: + +* a description of the evolution of a record (document) over time +* automatic actions based on various and flexible conditions +* management of company roles and validation steps +* management of interactions between objects +* a visual representation of document flows through their lifecycle + +For instance, a basic order could have the following flow: + +.. sphinx.ext.graphviz would be nice, but it requires ``dot`` on any machine +.. where the doc is compiled... otoh this is a pain in the ass because you +.. need 2 compilation steps (dot -> image and rst -> html) every time + +.. image:: workflow/order_0.* + :align: center + +Orders start in the *Draft* state, can be *Confirmed* by a user, and then +either shipped (*Closed*) or *Canceled*. + +A company using Odoo may want to add discount support to orders, where sales +staff has discretionary discounting powers up to 15%, but manager validation +is required for discounts beyond 15%. The workflow can be altered online to +add the relevant steps without editing Python or XML files: + +.. image:: workflow/order_1.* + :align: center + +Because Activities can perform arbitrary actions, the *Validation* can +automatically send a validation request to the relevant employee. + +.. note:: the order view needs to be modified to add an *Accept Discount* + button for managers + Basics ------ @@ -63,7 +97,7 @@ made up of two activies, named "a" and "b", and one transition, going from "a" to "b". The first activity has its attribute ``flow_start`` set to ``True`` so that -OpenERP knows where to start the workflow traversal after it is instanciated. +Odoo knows where to start the workflow traversal after it is instanciated. Because ``on_create`` is set to True on the workflow record, the workflow is instanciated for each newly created record. (Otherwise, the workflow should be instanciated by other means, such as from some module Python code.) @@ -77,6 +111,142 @@ The transition between "a" and "b" does not specify any condition. This means that the workflow instance immediately goes from "a" to "b" after "a" has been processed, and thus also processes activity "b". +Activities +---------- + +While the transitions can be seen as the control structures of the workflows, +activities are the places where everything happens, from changing record +states to sending email. + +Different kinds of activities exist: ``Dummy``, ``Function``, ``Subflow``, and +``Stop all``, each doing different things when the activity is processed. In +addition to their kind, activies have other properties, detailed in the next +sections. + +Flow start and flow stop +'''''''''''''''''''''''' + +The attribute ``flow_start`` is a boolean value specifying whether the activity +is processed when the workflow is instanciated. Multiple activities can have +their attribute ``flow_start`` set to ``True``. When instanciating a workflow +for a record, Odoo simply processes all of them, and evaluate all their +outgoing transitions afterwards. + +The attribute ``flow_stop`` is a boolean value specifying whether the activity +stops the workflow instance. A workflow instance is considered completed when +all its activities with the attribute ``flow_stop`` set to ``True`` are +completed. + +It is important for Odoo to know when a workflow instance is completed. A +workflow can have an activity that is actually another workflow (called a +subflow); that activity is completed when the subflow is completed. + +Subflow +''''''' + +An activity can embed a complete workflow, called a subflow (the embedding +workflow is called the parent workflow). The workflow to instanciate is +specified by attribute ``subflow_id``. + +.. note:: In the GUI, that attribute can not be set unless the kind of the + activity is ``Subflow``. + +The activity is considered completed (and its outgoing transitions ready to be +evaluated) when the subflow is completed (see attribute ``flow_stop`` above). + +Sending a signal from a subflow +''''''''''''''''''''''''''''''' + +When a workflow is embedded in an activity (as a subflow) of a workflow, the +sublow can send a signal from its own activities to the parent workflow by +giving a signal name in the attribute ``signal_send``. Odoo processes those +activities by sending the value of ``signal_send`` prefixed by "subflow." to +the parent workflow instance. + +In other words, it is possible to react and get transitions in the parent +workflow as activities are executed in the sublow. + +Server actions +'''''''''''''' + +An activity can run a "Server Action" by specifying its ID in the attribute +``action_id``. + +Python action +''''''''''''' + +An activity can execute some Python code, given by the attribute ``action``. +The evaluation environment is the same as the one explained in the section +`Conditions`_. + +Split mode +'''''''''' + +After an activity has been processed, Odoo evaluates its transition to reach +the next activity in the flow. + +However if an activity has more than one transition, Odoo must decide which +activity or activities to follow. + +.. image:: workflow/split.* + :align: center + +This choice is controlled by the ``split_mode`` attribute: + +``XOR`` (default) + By default, Odoo will use the first transition (in ``sequence`` order) + whose condition is satisfied. All other transitions are ignored. +``OR`` + In ``OR`` mode, all transitions with a satisfied condition are traversed + simultanously. Transitions not yet valid will be ignored, even if they + become valid later. +``AND`` + In ``AND`` mode, Odoo will wait until *all* transitions are satisfied, and + will traverse all of them (much like the ``OR`` mode). + +Both ``OR`` and ``AND`` mode will lead to activities being active in the same +workflow. + +Join mode +''''''''' + +Just like outgoing transition conditions can be combined together to decide +whether they can be traversed or not, incoming transitions can be combined +together to decide if and when an activity may be processed. + +.. image:: workflow/join.* + :align: center + +The ``join_mode`` attribute controls that behavior: + +``XOR`` (default) + Any incoming transition enables the activity and starts its processing. +``AND`` + The activity is enabled and processed only once *all* incoming transitions + have been traversed. + +Kinds +''''' + +An activity's kind defines the type of work an activity can perform. + +Dummy (``dummy``, default) + Do nothing at all, or call a server action. Often used as dispatch or + gather "hubs" for transitions. +Function (``function``) + Run some python code, execute a server action. +Stop all (``stopall``) + Completely stops the workflow instance and marks it as completed. +Subflow (``subflow``) + Starts executing an other workflow, once that workflow is completed the + activity is done processing. + + By default, the subflow is instanciated for the same record as the parent + workflow. It is possible to change that behavior by providing Python code + that returns a record ID (of the same data model as the subflow). The + embedded subflow instance is then the one of the given record. + + Transitions ----------- @@ -98,7 +268,7 @@ Conditions When an activity has been completed, its outgoing transitions are inspected to determine whether it is possible for the workflow instance to proceed through them and reach the next activities. When only a condition is defined (i.e., no -signal or trigger is defined), the condition is evaluated by OpenERP, and if +signal or trigger is defined), the condition is evaluated by Odoo, and if it evaluates to ``True``, the worklfow instance progresses through the transition. If the condition is not met, it will be reevaluated every time the associated record is modified, or by an explicit method call to do it. @@ -109,7 +279,7 @@ may be several lines long; in that case, the value of the last one determines whether the transition can be taken. In the condition evaluation environment, several symbols are conveniently -defined (in addition to the OpenERP ``safe_eval`` environment): +defined (in addition to the Odoo ``safe_eval`` environment): - all the model column names, and - all the browse record's attributes. @@ -152,151 +322,3 @@ record IDs in the given model. Any of those records can wake up the workflow instance they are associated with. .. note:: triggers are not re-installed whenever the transition is re-tried. - -Splitting and joining transitions -''''''''''''''''''''''''''''''''' - -When multiple transitions leave the same activity, or lead to the same -activity, OpenERP provides some control over which transitions are actually -taken, or how the reached activity will be processed. The attributes -``split_mode`` and ``join_mode`` on the activity are used for such -control. The possible values of those attributes are explained below. - -Activities ----------- - -While the transitions can be seen as the control structures of the workflows, -activities are the places where everything happens, from changing record -states to sending email. - -Different kinds of activities exist: ``Dummy``, ``Function``, ``Subflow``, and -``Stop all``, each doing different things when the activity is processed. In -addition to their kind, activies have other properties, detailed in the next -sections. - -Flow start and flow stop -'''''''''''''''''''''''' - -The attribute ``flow_start`` is a boolean value specifying whether the activity -is processed when the workflow is instanciated. Multiple activities can have -their attribute ``flow_start`` set to ``True``. When instanciating a workflow -for a record, OpenERP simply processes all of them, and evaluate all their -outgoing transitions afterwards. - -The attribute ``flow_stop`` is a boolean value specifying whether the activity -stops the workflow instance. A workflow instance is considered completed when -all its activities with the attribute ``flow_stop`` set to ``True`` are -completed. - -It is important for OpenERP to know when a workflow instance is completed. A -workflow can have an activity that is actually another workflow (called a -subflow); that activity is completed when the subflow is completed. - -Subflow -''''''' - -An activity can embed a complete workflow, called a subflow (the embedding -workflow is called the parent workflow). The workflow to instanciate is -specified by attribute ``subflow_id``. - -.. note:: In the GUI, that attribute can not be set unless the kind of the - activity is ``Subflow``. - -The activity is considered completed (and its outgoing transitions ready to be -evaluated) when the subflow is completed (see attribute ``flow_stop`` above). - -Sending a signal from a subflow -''''''''''''''''''''''''''''''' - -When a workflow is embedded in an activity (as a subflow) of a workflow, the -sublow can send a signal from its own activities to the parent workflow by -giving a signal name in the attribute ``signal_send``. OpenERP processes those -activities by sending the value of ``signal_send`` prefixed by "subflow." to -the parent workflow instance. - -In other words, it is possible to react and get transitions in the parent -workflow as activities are executed in the sublow. - -Server actions -'''''''''''''' - -An activity can run a "Server Action" by specifying its ID in the attribute -``action_id``. - -Python action -''''''''''''' - -An activity can execute some Python code, given by the attribute ``action``. -The evaluation environment is the same as the one explained in the section -`Conditions`_. - -Split mode -'''''''''' - -After an activity has been processed, its outgoing transitions are evaluated. -Normally, if a transition can be taken, OpenERP traverses it and proceed to -the activity the transition leads to. - -Actually, when more than a single transition is leaving an activity, OpenERP -may proceed or not, depending on the other transitions. That is, the -conditions on the transitions can be combined together, and the combined -result instructs OpenERP to traverse zero, one, or all the transitions. The -way they are combined is controlled by the attribute ``split_mode``. - -There are three possible split modes: ``XOR``, ``OR`` and ``AND``. - -``XOR`` - When the transitions are combined with a ``XOR`` split mode, as soon as a - transition has a satisfied condition, the transition is traversed and the - others are skipped. -``OR`` - With the ``OR`` mode, all the transitions with a satisfied condition are - traversed. The remaining transitions will not be evaluated later. -``AND`` - With the ``AND`` mode, OpenERP will wait for all outgoing transition - conditions to be satisfied, then traverse all of them at once. - -Join mode -''''''''' - -Just like outgoing transition conditions can be combined together to decide -whether they can be traversed or not, incoming transitions can be combined -together to decide if and when an activity may be processed. The attribute -``join_mode`` controls that behavior. - -There are two possible join modes: ``XOR`` and ``AND``. - -``XOR`` - With the ``XOR`` mode, an incoming transition with a satisfied condition - is traversed immediately, and enables the processing of the activity. - -``AND`` - With the ``AND`` mode, OpenERP will wait until all incoming transitions - have been traversed before enabling the processing of the activity. - -Kinds -''''' - -Activities can be of different kinds: ``dummy``, ``function``, ``subflow``, or -``stopall``. The kind defines what type of work an activity can do. - -Dummy - The ``dummy`` kind is for activities that do nothing, or for activities - that only call a server action. Activities that do nothing can be used as - hubs to gather/dispatch transitions. -Function - The ``function`` kind is for activities that only need to run some Python - code, and possibly a server action. -Stop all - The ``stopall`` kind is for activities that will completely stop the - workflow instance and mark it as completed. In addition they can also run - some Python code. -Subflow - When the kind of the activity is ``subflow``, the activity embeds another - workflow instance. When the subflow is completed, the activity is also - considered completed. - - By default, the subflow is instanciated for the same record as the parent - workflow. It is possible to change that behavior by providing Python code - that returns a record ID (of the same data model as the subflow). The - embedded subflow instance is then the one of the given record.