1
=========================
2
Workflow-Business Process
3
=========================
8
The workflow system in Open ERP is a very powerful mechanism that can describe the evolution of documents (model) in time.
10
Workflows are entirely customizable, they can be adapted to the flows and trade logic of almost any company. The workflow system makes Tiny ERP very flexible and allows it to easily support changing needs without having to program new functionalities.
15
* description of document evolution in time
16
* automatic trigger of actions if some conditions are met
17
* management of company roles and validation steps
18
* management of interactions between the different objects/modules
19
* graphical tool for visualization of document flows
21
**To understand its utility, see these three examples:**
24
WkfExample1: Discount On Orders
25
-------------------------------
27
The first diagram represent a very basic workflow of an order:
29
.. image:: images/Workflow_bc1.png
31
The order starts in the 'draft' state, when it is in redaction and not approved. When the user press on the 'Confirm' button, the invoice is created and the order comes into the 'CONFIRMED' state.
33
Then, two operations are possible:
35
#. the order is done (shipped)
37
#. the order is canceled
39
Let's suppose a company has a need not implemented in OpenERP. For example, suppose their sales staff can only offer discounts of 15% or less. Every order having a discount above 15% must be approved by the sales manager.
41
This modification in the sale logic doesn't need any line of python code! A simple modification of the workflow allows us to take this new need into account and add the extra validation step.
43
.. image:: images/Workflow_bc2.png
45
The workflow is thus modified as above and the orders will react as we want to. We then only need to modify the order form view and add a validation button at the desired location.
47
We could then further improve this workflow by sending a request to the sales manager when an order enters the 'Validation' state. Workflow nodes can execute object methods; only two lines of Python are needed to send a request asking the sales manager to validate or not the order.
50
WkfExample2: A sale order that generates an invoice and a shipping order.
51
-------------------------------------------------------------------------
54
.. image:: images/Workflow_sale.png
56
WkfExample3: Acount invoice basic workflow
58
.. image:: images/Acount_inv_wkf.jpg
62
Workflows are defined in the file server/bin/addons/base/ir/workflow/workflow.py. The first three classes defined in this file are workflow, wkf_activity and wkf_transition. They correspond to the three types of resources that are necessary to describe a workflow :
64
* `workflow <http://openobject.com/wiki/index.php/WkfDefXML>`_ : the workflow,
65
* `wkf_activity <http://openobject.com/wiki/index.php/WorkflowActivity>`_ : the activities (nodes),
66
* `wkf_transition <http://openobject.com/wiki/index.php/WorkflowTransition>`_ : the transitions between the activities.
69
General structure of a workflow XML file
70
========================================
72
The general structure of a workflow XML file is as follows :
79
<record model="workflow" id=workflow_id>
81
<field name="name">workflow.name</field>
82
<field name="osv">resource.model</field>
83
<field name="on_create">True | False</field>
92
* **id** (here "workflow_id") is a workflow identifier. Each workflow must have an unique identifier.
93
* **name** (here "workflow.name") is the name of the workflow. The name of the workflow must respect the Open ERP syntax of "dotted names".
94
* **osv** (here "resource.model") is the name of the Tiny object we use as a model [-(Remember a Open object inherits from osv.osv, hence the '<field name="osv">')-].
95
* **on_create** is True if workflow.name must be instantiated automatically when resource.model is created, and False otherwise.
99
The workflow **"sale.order.basic"** defined in addons/sale/sale_workflow.xml follows exactly this model, the code of its workflow tag is :
103
<record model="workflow" id="wkf_sale">
105
<field name="name">sale.order.basic</field>
106
<field name="osv">sale.order</field>
107
<field name="on_create">True</field>
117
The wkf_activity class represents the nodes of workflows. These nodes are the actions to be executed.
125
.. image:: images/Wkf_split.png
128
* XOR: One necessary transition, takes the first one found (default).
129
* OR : Take only valid transitions (0 or more) in sequential order.
130
* AND: All valid transitions are launched at the same time (fork).
133
In the OR and AND separation mode, certain workitems can be generated.
135
In the AND mode, the activity waits for all transitions to be valid, even if some of them are already valid. They are all triggered at the same time.
139
.. image:: images/Wkf_join.png
142
* **XOR**: One transition necessary to continue to the destination activity (default).
143
* **AND**: Waits for all transition conditions to be valid to execute the destination activity.
148
:The type of the activity can take several values:
150
* **DUMMY**: Do nothing (default).
151
* **FUNCTION**: Execute the function selected by an action.
152
* **SUBFLOW**: Execute a sub-workflow SUBFLOW_ID. The action method must return the ID of the concerned resource by the subflow ! If the action returns False, the workitem disappears !
155
A sub-workflow is executed when an activity is of the type SUBFLOW. This activity ends when the sub-workflow has finished. While the sub-workflow is active, the workitem of this activity is frozen.
160
The action indicates the method to execute when a workitem comes into this activity. The method must be defined in a object which belongs this workflow and have the following signature:
162
def object_method(self, cr, uid, ids):
164
In the action though, they will be called by a statement like:
177
Indicates if the node is a start node. When a new instance of a workflow is created, a workitem is activated for each activity marked as a flow_start.
179
Be warned to not use this flag unless your activity really is a "flow start". There are tiny versions that do not care about the tags contents like "true" or "false". Using such tag and tiny version, you will always end up whith an activity which is tagged as "flow start = true", leaving u with a nasty hunt to find out where your workflowdesign could be wrong.
184
Indicates if the node is an ending node. When all the active workitems for a given instance come in the node marked by flow_stop, the workflow is finished.
186
Be warned to not use this flag unless your activity really is a "flow stop". There are tiny versions that do not care about the tags contents like "true" or "false". Using such tag and tiny version, you will always end up whith an activity which is tagged as "flow stop = true", leaving u with a nasty hunt to find out where your workflowdesign could be wrong.
191
The workflow which this activity belongs to.
192
Defining activities using XML files
194
The general structure of an activity record is as follows
195
---------------------------------------------------------
199
<record model="workflow.activity" id="''activity_id''">
200
<field name="wkf_id" ref="''workflow_id''"/>
201
<field name="name">''activity.name''</field>::
203
<field name="split_mode">XOR | OR | AND</field>
204
<field name="join_mode">XOR | AND</field>
205
<field name="kind">dummy | function | subflow | stopall</field>
207
<field name="action">''(...)''</field>
208
<field name="signal_send">''(...)''</field>
209
<field name="flow_start">True | False</field>
210
<field name="flow_stop">True | False</field>
213
The first two arguments **wkf_id** and name are mandatory. Be warned to not use **flow_start** and **flow_stop** unless your activity really is a **flow start** or **flow_stop**. There are tiny versions that do not care about the tags contents like "True" or "False".
217
There are too many possibilities of activity definition to choose from using this definition. We recommend you to have a look at the file **server/bin/addons/sale/sale_workflow.xml** for several examples of activity definitions.
225
Workflow transitions are the conditions to be satisfied to go from one activity to the next one. They are represented by one-way arrows joining two activities.
227
The conditions are of different types:
229
* role to satisfy by the user
230
* button pressed in the interface
231
* end of a subflow through a selected activity of subflow
233
The roles and signals are evaluated before the expression. If a role or a signal is false, the expression will not be evaluated.
235
Transition tests may not write values in objects.
241
Source activity. When this activity is over, the condition is tested to determine if we can start the ACT_TO activity.
247
The destination activity.
253
**Expression** to be satisfied if we want the transition done.
259
When the operation of transition comes from a button pressed in the client form, signal tests the name of the pressed button.
261
If signal is NULL, no button is necessary to validate this transition.
267
The **role** that a user must have to validate this transition.
268
Defining Transitions Using XML Files
270
The general structure of a transition record is as follows
274
<record model="workflow.transition" id="transition_id">
276
<field name="act_from" ref="activity_id'_1_'"/>
277
<field name="act_to" ref="activity_id'_2_'"/>
279
<field name="signal">(...)</field>
280
<field name="role_id" ref="role_id'_1_'"/>
281
<field name="condition">(...)</field>
283
<field name="trigger_model">(...)</field>
284
<field name="trigger_expr_id">(...)</field>
288
Only the fields **act_from** and **act_to** are mandatory.
293
Expressions are written as in python:
297
* 'hello' in ['hello','bye']
299
Any field from the resource the workflow refers to can be used in these expressions. For example, if you were creating a workflow for partner addresses, you could use expressions like:
306
Roles can be attached to transitions. If a role is given for a transition, that transition can only be executed if the user who triggered it possess the necessary role.
308
Each user can have one or several roles. Roles are defined in a tree of roles, parent roles having the rights of all their children.
326
Let's suppose we handle our own bug database and that the action of marking a bug as valid needs the Testers role. In the example tree above, marking a bug as valid could be done by all the users having the following roles: Testers, Lead developper, Technical manager, CEO.
331
As of this writing, there is no exception handling in workflows.
333
Workflows being made of several actions executed in batch, they can't trigger exceptions. In order to improve the execution efficiency and to release a maximum of locks, workflows commit at the end of each activity. This approach is reasonable because an activity is only started if the conditions of the transactions are satisfied.
335
The only problem comes from exceptions due to programming errors; in that case, only transactions belonging to the entirely terminated activities are executed. Other transactions are "rolled back".
340
Steps for creating a simple state-changing workflow for a custom module called **mymod**
343
Define the States of your object
344
++++++++++++++++++++++++++++++++
346
The first step is to define the States your object can be in. We do this by adding a 'state' field to our object, in the _columns collection
348
.. code-block:: python
352
'state': fields.selection([
354
('assigned','Assigned'),
355
('negotiation','Negotiation'),
357
('lost','Lost')], 'Stage', readonly=True),
360
Define the State-change Handling Methods
361
++++++++++++++++++++++++++++++++++++++++
363
Add the following additional methods to your object. These will be called by our workflow buttons
365
.. code-block:: python
367
def mymod_new(self, cr, uid, ids):
368
self.write(cr, uid, ids, { 'state' : 'new' })
371
def mymod_assigned(self, cr, uid, ids):
372
self.write(cr, uid, ids, { 'state' : 'assigned' })
375
def mymod_negotiation(self, cr, uid, ids):
376
self.write(cr, uid, ids, { 'state' : 'negotiation' })
379
def mymod_won(self, cr, uid, ids):
380
self.write(cr, uid, ids, { 'state' : 'won' })
383
def mymod_lost(self, cr, uid, ids):
384
self.write(cr, uid, ids, { 'state' : 'lost' })
387
Obviously you would extend these methods in the future to do something more useful!
389
Create your Workflow XML file
390
+++++++++++++++++++++++++++++
392
There are three types of records we need to define in a file called mymod_workflow.xml
394
#. Workflow header record (only one of these)
398
<record model="workflow" id="wkf_mymod">
399
<field name="name">mymod.wkf</field>
400
<field name="osv">mymod.mymod</field>
401
<field name="on_create">True</field>
404
#. Workflow Activity records
406
These define the actions that should be executed when the workflow reaches a particular state
410
<record model="workflow.activity" id="act_new">
411
<field name="wkf_id" ref="wkf_mymod" />
412
<field name="flow_start">True</field>
413
<field name="name">new</field>
414
<field name="kind">function</field>
415
<field name="action">mymod_new()</field>
418
<record model="workflow.activity" id="act_assigned">
419
<field name="wkf_id" ref="wkf_mymod" />
420
<field name="name">assigned</field>
421
<field name="kind">function</field>
422
<field name="action">mymod_assigned()</field>
425
<record model="workflow.activity" id="act_negotiation">
426
<field name="wkf_id" ref="wkf_mymod" />
427
<field name="name">negotiation</field>
428
<field name="kind">function</field>
429
<field name="action">mymod_negotiation()</field>
432
<record model="workflow.activity" id="act_won">
433
<field name="wkf_id" ref="wkf_mymod" />
434
<field name="name">won</field>
435
<field name="kind">function</field>
436
<field name="action">mymod_won()</field>
437
<field name="flow_stop">True</field>
440
<record model="workflow.activity" id="act_lost">
441
<field name="wkf_id" ref="wkf_mymod" />
442
<field name="name">lost</field>
443
<field name="kind">function</field>
444
<field name="action">mymod_lost()</field>
445
<field name="flow_stop">True</field>
448
#. Workflow Transition records
450
These define the possible transitions between workflow states
454
<record model="workflow.transition" id="t1">
455
<field name="act_from" ref="act_new" />
456
<field name="act_to" ref="act_assigned" />
457
<field name="signal">mymod_assigned</field>
460
<record model="workflow.transition" id="t2">
461
<field name="act_from" ref="act_assigned" />
462
<field name="act_to" ref="act_negotiation" />
463
<field name="signal">mymod_negotiation</field>
466
<record model="workflow.transition" id="t3">
467
<field name="act_from" ref="act_negotiation" />
468
<field name="act_to" ref="act_won" />
469
<field name="signal">mymod_won</field>
472
<record model="workflow.transition" id="t4">
473
<field name="act_from" ref="act_negotiation" />
474
<field name="act_to" ref="act_lost" />
475
<field name="signal">mymod_lost</field>
478
Add mymod_workflow.xml to __terp__.py
480
Edit your module's __terp__.py and add mymod_workflow.xml to the "update_xml" array, so that OpenERP picks it up next time your module is loaded.
481
Add Workflow Buttons to your View
483
The final step is to add the required buttons to mymod_views.xml file.
485
Add the following at the end of the <form> section of your object's view definition:
489
<separator string="Workflow Actions" colspan="4"/>
490
<group colspan="4" col="3">
491
<button name="mymod_assigned" string="Assigned" states="new" />
492
<button name="mymod_negotiation" string="In Negotiation" states="assigned" />
493
<button name="mymod_won" string="Won" states="negotiating" />
494
<button name="mymod_lost" string="Lost" states="negotiating" />
500
Now use the Module Manager to install or update your module. If you have done everything correctly you shouldn't get any errors. You can check if your workflow is installed in Administration -> Customisation -> Workflow Definitions
502
When you are testing, remember that the workflow will only apply to NEW records that you create.
507
If your buttons do not seem to be doing anything, one of the following two things are likely:
509
1. The record you are working on does not have a Workflow Instance record associated with it (it was probably created before you defined your workflow)
510
2. You have not set the "osv" field correctly in your workflow XML file
added
removed
build/html/_sources/part_3/wf_changes.txt
