[ADD] base_action_rule: Added new module which can be used to set action rules for any object.

bzr revid: uco@tinyerp.co.in-20100202134702-33lb9937qdr257y7
This commit is contained in:
uco (OpenERP) 2010-02-02 19:17:02 +05:30
parent d0b7144c0f
commit 644fb6d0fa
6 changed files with 448 additions and 0 deletions

View File

@ -0,0 +1,24 @@
# -*- coding: utf-8 -*-
##############################################################################
#
# OpenERP, Open Source Management Solution
# Copyright (C) 2004-2010 Tiny SPRL (<http://tiny.be>).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
import base_action_rule
# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:

View File

@ -0,0 +1,39 @@
# -*- coding: utf-8 -*-
##############################################################################
#
# OpenERP, Open Source Management Solution
# Copyright (C) 2004-2010 Tiny SPRL (<http://tiny.be>).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
{
'name': 'Action Rule',
'version': '1.0',
'category': 'Generic Modules/Others',
'description': "This module allows to implement action rules for any object.",
'author': 'Tiny',
'website': 'http://www.openerp.com',
'depends': ['base'],
'init_xml': ['base_action_rule_data.xml'],
'update_xml': [
'base_action_rule_view.xml',
'security/ir.model.access.csv',
],
'demo_xml': [],
'installable': True,
'active': False,
}
# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:

View File

@ -0,0 +1,187 @@
import time
import mx.DateTime
from osv import fields, osv, orm
from osv.orm import except_orm
AVAILABLE_STATES = [
('draft','Draft'),
('open','Open'),
('cancel', 'Cancelled'),
('done', 'Closed'),
('pending','Pending')
]
AVAILABLE_PRIORITIES = [
('5','Lowest'),
('4','Low'),
('3','Normal'),
('2','High'),
('1','Highest')
]
class base_action_rule(osv.osv):
_name = 'base.action.rule'
_description = 'Action Rules'
_columns = {
'name': fields.many2one('ir.model', 'Model', required=True),
'max_level': fields.integer('Max Level'),
'rule_lines': fields.one2many('base.action.rule.line','rule_id','Rule Lines'),
'create_date': fields.datetime('Create Date', readonly=1)
}
def _check(self, cr, uid, ids=False, context={}):
'''
Function called by the scheduler to process models
'''
ruleobj = self.pool.get('base.action.rule')
ids = ruleobj.search(cr, uid, [])
rules = ruleobj.browse(cr, uid, ids, context)
return ruleobj._action(cr, uid, rules, False, context=context)
def _action(self, cr, uid, rules, state_to, scrit=None, context={}):
if not scrit:
scrit = []
history = []
history_obj = self.pool.get('base.action.rule.history')
if rules:
cr.execute('select * from base_action_rule_history where rule_id in (%s)' %(','.join(map(lambda x: "'"+str(x.id)+"'",rules))))
history = cr.fetchall()
checkids = map(lambda x: x[0], history or [])
if not len(history) or len(history) < len(rules):
for rule in rules:
if rule.id not in checkids:
lastDate = mx.DateTime.strptime(rule.create_date[:19], '%Y-%m-%d %H:%M:%S')
history_obj.create(cr, uid, {'rule_id': rule.id, 'res_id': rule.name.id, 'date_action_last': lastDate})
for rule in rules:
for action in rule.rule_lines:
if action.trg_date_type=='create':
base = mx.DateTime.strptime(rule.create_date[:19], '%Y-%m-%d %H:%M:%S')
elif action.trg_date_type=='action_last':
for hist in history:
if hist[6]:
base = mx.DateTime.strptime(hist[6][:19], '%Y-%m-%d %H:%M:%S')
else:
base = mx.DateTime.strptime(rule.create_date[:19], '%Y-%m-%d %H:%M:%S')
history_obj.write(cr, uid, [hist[0]], {'date_action_last': base})
elif action.trg_date_type=='deadline' and rule.name.date_deadline:
base = mx.DateTime.strptime(rule.name.date_deadline, '%Y-%m-%d %H:%M:%S')
elif action.trg_date_type=='date' and rule.name.date:
base = mx.DateTime.strptime(rule.name.date, '%Y-%m-%d %H:%M:%S')
if base:
fnct = {
'minutes': lambda interval: mx.DateTime.RelativeDateTime(minutes=interval),
'day': lambda interval: mx.DateTime.RelativeDateTime(days=interval),
'hour': lambda interval: mx.DateTime.RelativeDateTime(hours=interval),
'month': lambda interval: mx.DateTime.RelativeDateTime(months=interval),
}
d = base + fnct[action.trg_date_range_type](action.trg_date_range)
dt = d.strftime('%Y-%m-%d %H:%M:%S')
for hist in history:
if not hist[8] or dt < hist[8]:
history_obj.write(cr, uid, [hist[0]], {'date_action_next': dt}, context)
return True
base_action_rule()
class base_action_rule_line(osv.osv):
_name = 'base.action.rule.line'
_description = 'Action Rule Lines'
_columns = {
'name': fields.char('Rule Name',size=64, required=True),
'rule_id': fields.many2one('base.action.rule','Rule'),
'active': fields.boolean('Active', help="If the active field is set to true, it will allow you to hide the case rule without removing it."),
'sequence': fields.integer('Sequence', help="Gives the sequence order when displaying a list of case rules."),
'trg_state_from': fields.selection([('',''),('escalate','Escalate')]+AVAILABLE_STATES, 'State', size=16),
'trg_state_to': fields.selection([('',''),('escalate','Escalate')]+AVAILABLE_STATES, 'Button Pressed', size=16),
'trg_date_type': fields.selection([
('none','None'),
('create','Creation Date'),
('action_last','Last Action Date'),
('deadline','Deadline'),
('date','Date'),
], 'Trigger Date', size=16),
'trg_date_range': fields.integer('Delay after trigger date',help="Delay After Trigger Date, specifies you can put a negative number " \
"if you need a delay before the trigger date, like sending a reminder 15 minutes before a meeting."),
'trg_date_range_type': fields.selection([('minutes', 'Minutes'),('hour','Hours'),('day','Days'),('month','Months')], 'Delay type'),
'trg_user_id': fields.many2one('res.users', 'Responsible'),
'trg_partner_id': fields.many2one('res.partner', 'Partner'),
'trg_partner_categ_id': fields.many2one('res.partner.category', 'Partner Category'),
'trg_priority_from': fields.selection([('','')] + AVAILABLE_PRIORITIES, 'Minimum Priority'),
'trg_priority_to': fields.selection([('','')] + AVAILABLE_PRIORITIES, 'Maximim Priority'),
'act_method': fields.char('Call Object Method', size=64),
'act_state': fields.selection([('','')]+AVAILABLE_STATES, 'Set state to', size=16),
'act_user_id': fields.many2one('res.users', 'Set responsible to'),
'act_priority': fields.selection([('','')] + AVAILABLE_PRIORITIES, 'Set priority to'),
'act_email_cc': fields.char('Add watchers (Cc)', size=250, help="These people will receive a copy of the future communication between partner and users by email"),
'act_remind_partner': fields.boolean('Remind Partner', help="Check this if you want the rule to send a reminder by email to the partner."),
'act_remind_user': fields.boolean('Remind responsible', help="Check this if you want the rule to send a reminder by email to the user."),
'act_remind_attach': fields.boolean('Remind with attachment', help="Check this if you want that all documents attached to the case be attached to the reminder email sent."),
'act_mail_to_user': fields.boolean('Mail to responsible',help="Check this if you want the rule to send an email to the responsible person."),
'act_mail_to_partner': fields.boolean('Mail to partner',help="Check this if you want the rule to send an email to the partner."),
'act_mail_to_watchers': fields.boolean('Mail to watchers (CC)',help="Check this if you want the rule to mark CC(mail to any other person defined in actions)."),
'act_mail_to_email': fields.char('Mail to these emails', size=128,help="Email-id of the persons whom mail is to be sent"),
'act_mail_body': fields.text('Mail body',help="Content of mail"),
'regex_name': fields.char('Regular Expression on Case Name', size=128),
'regex_history': fields.char('Regular Expression on Case History', size=128),
'server_action_id': fields.many2one('ir.actions.server','Server Action',help="Describes the action name." \
"eg:on which object which ation to be taken on basis of which condition"),
}
_defaults = {
'active': lambda *a: 1,
'trg_date_type': lambda *a: 'none',
'trg_date_range_type': lambda *a: 'day',
'act_mail_to_user': lambda *a: 0,
'act_remind_partner': lambda *a: 0,
'act_remind_user': lambda *a: 0,
'act_mail_to_partner': lambda *a: 0,
'act_mail_to_watchers': lambda *a: 0,
}
_order = 'sequence'
def _check_mail(self, cr, uid, ids, context=None):
emptycase = orm.browse_null()
for rule in self.browse(cr, uid, ids):
if rule.act_mail_body:
try:
obj = self.pool.get(rule.rule_id.name.model)
obj.format_mail(emptycase, rule.act_mail_body)
except (ValueError, KeyError, TypeError):
return False
return True
_constraints = [
(_check_mail, 'Error: The mail is not well formated', ['act_mail_body']),
]
base_action_rule_line()
class base_action_rule_history(osv.osv):
_name = 'base.action.rule.history'
_description = 'Action Rule History'
_rec_name = 'rule_id'
_columns = {
'rule_id': fields.many2one('base.action.rule','Rule', required=True, readonly=1),
'res_id': fields.integer('Resource ID', readonly=1),
'date_action_last': fields.datetime('Last Action', readonly=1),
'date_action_next': fields.datetime('Next Action', readonly=1),
}
base_action_rule_history()
# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:

View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<openerp>
<data>
<record id="ir_cron_base_action" model="ir.cron">
<field name="name">Check Rules</field>
<field name="interval_number">4</field>
<field name="interval_type">hours</field>
<field name="numbercall">-1</field>
<field eval="False" name="doall"/>
<field eval="'base.action.rule'" name="model"/>
<field eval="'_check'" name="function"/>
<field eval="'()'" name="args"/>
</record>
</data>
</openerp>

View File

@ -0,0 +1,179 @@
<?xml version="1.0" encoding="utf-8"?>
<openerp>
<data>
<menuitem id="menu_base_action_rule" name="Action Rule" parent="base.menu_base_config" sequence="0"/>
<!--
Action Rule
-->
<record id="view_base_action_rule_form" model="ir.ui.view">
<field name="name">base.action.rule.form</field>
<field name="model">base.action.rule</field>
<field name="type">form</field>
<field name="arch" type="xml">
<form string="Action Rule">
<field name="name" select="1"/>
<field name="max_level" select="1"/>
<field name="rule_lines" colspan="4"/>
</form>
</field>
</record>
<record id="view_base_action_rule_tree" model="ir.ui.view">
<field name="name">base.action.rule.tree</field>
<field name="model">base.action.rule</field>
<field name="type">tree</field>
<field name="arch" type="xml">
<tree string="Action Rule">
<field name="name" select="1"/>
<field name="max_level" select="1"/>
<field name="rule_lines"/>
</tree>
</field>
</record>
<record id="base_action_rule_act" model="ir.actions.act_window">
<field name="name">Action Rules</field>
<field name="res_model">base.action.rule</field>
<field name="view_type">form</field>
<field name="view_mode">tree,form</field>
<field name="view_id" ref="view_base_action_rule_tree"/>
</record>
<menuitem id="menu_base_action_rule_form" parent="menu_base_action_rule" action="base_action_rule_act"/>
<!--
Action Rule Lines
-->
<record id="view_base_action_rule_line_form" model="ir.ui.view">
<field name="name">base.action.rule.line.form</field>
<field name="model">base.action.rule.line</field>
<field name="type">form</field>
<field name="arch" type="xml">
<form string="Action Rule Line">
<field name="name" select="1"/>
<field name="active" select="2"/>
<notebook colspan="4">
<page string="Conditions">
<separator colspan="4" string="Conditions on States"/>
<field name="trg_state_from" select="2"/>
<field name="trg_state_to" select="2"/>
<separator colspan="4" string="Conditions on Case Fields"/>
<field name="regex_name" string="Regex on Case Name" colspan="2"/>
<field name="trg_user_id" select="2"/>
<separator colspan="4" string="Conditions on Case Partner"/>
<field name="trg_partner_id"/>
<field name="trg_partner_categ_id"/>
<separator colspan="4" string="Conditions on Priority Range"/>
<field name="trg_priority_from"/>
<field name="trg_priority_to"/>
<separator colspan="4" string="Conditions on Timing"/>
<field name="trg_date_type"/>
<label align="1.0" string="Delay After Trigger Date:"/>
<group col="2" colspan="1">
<field name="trg_date_range" nolabel="1"/>
<field name="trg_date_range_type" nolabel="1"/>
</group>
<separator colspan="4" string="Condition on Communication History"/>
<field name="regex_history" string="Regex on Communication History"/>
<separator colspan="4" string="Note"/>
<label align="0.0" string="The rule use a AND operator. The case must match all non empty fields so that the rule execute the action described in the 'Actions' tab." colspan="4"/>
</page>
<page string="Actions">
<separator colspan="4" string="Fields to Change"/>
<field name="act_state"/>
<field name="act_user_id"/>
<field name="act_priority"/>
<separator colspan="4" string="E-Mail Reminders (includes the content of the case)"/>
<field name="act_remind_user"/>
<field name="act_remind_partner"/>
<field name="act_remind_attach"/>
<field colspan="4" name="act_email_cc"/>
<separator colspan="4" string="Server Action to be Triggered"/>
<field name="server_action_id"/>
</page>
<page string="E-Mail Actions">
<separator colspan="4" string="Template of Email to Send"/>
<field name="act_mail_to_user"/>
<field name="act_mail_to_partner"/>
<field name="act_mail_to_watchers"/>
<field colspan="4" name="act_mail_to_email"/>
<field colspan="4" name="act_mail_body"/>
<separator colspan="4" string="Special Keywords to Be Used in The Body"/>
<label align="0.0" string="%%(case_id)s = Case ID" colspan="2"/>
<label align="0.0" string="%%(case_subject)s = Case subject" colspan="2"/>
<label align="0.0" string="%%(case_description)s = Case description" colspan="2"/>
<label align="0.0" string="%%(case_date)s = Creation date" colspan="2"/>
<label align="0.0" string="%%(email_from)s = Partner email" colspan="2"/>
<label align="0.0" string="%%(partner)s = Partner name" colspan="2"/>
<label align="0.0" string="%%(partner_email)s = Partner email" colspan="2"/>
<label align="0.0" string="%%(case_user)s = Responsible name" colspan="2"/>
<label align="0.0" string="%%(case_user_email)s = Responsible email" colspan="2"/>
<label align="0.0" string="%%(case_user_phone)s = Responsible phone" colspan="2"/>
<label align="0.0" string="%% = The &apos;%%&apos; Character" colspan="2"/>
</page>
</notebook>
</form>
</field>
</record>
<record id="view_base_action_rule_line_tree" model="ir.ui.view">
<field name="name">base.action.rule.line.tree</field>
<field name="model">base.action.rule.line</field>
<field name="type">tree</field>
<field name="arch" type="xml">
<tree string="Action Rule Lines">
<field name="name"/>
<field name="active"/>
</tree>
</field>
</record>
<record id="base_action_rule_line_act" model="ir.actions.act_window">
<field name="name">Action Rule Lines</field>
<field name="res_model">base.action.rule.line</field>
<field name="view_type">form</field>
<field name="view_mode">tree,form</field>
<field name="view_id" ref="view_base_action_rule_line_tree"/>
</record>
<menuitem action="base_action_rule_line_act" id="menu_base_action_rule_line_form" parent="menu_base_action_rule"/>
<!--
Action Rule History
-->
<record id="view_base_action_rule_history_form" model="ir.ui.view">
<field name="name">base.action.rule.history.form</field>
<field name="model">base.action.rule.history</field>
<field name="type">form</field>
<field name="arch" type="xml">
<form string="Action Rule History">
<field name="rule_id" select="1"/>
<field name="res_id" select="1"/>
<field name="date_action_last"/>
<field name="date_action_next"/>
</form>
</field>
</record>
<record id="view_base_action_rule_history_tree" model="ir.ui.view">
<field name="name">base.action.rule.history.tree</field>
<field name="model">base.action.rule.history</field>
<field name="type">tree</field>
<field name="arch" type="xml">
<tree string="Action Rule History">
<field name="rule_id" select="1"/>
<field name="res_id" select="1"/>
<field name="date_action_last"/>
<field name="date_action_next"/>
</tree>
</field>
</record>
<record id="base_action_rule_history_act" model="ir.actions.act_window">
<field name="name">Action Rule History</field>
<field name="res_model">base.action.rule.history</field>
<field name="view_type">form</field>
<field name="view_mode">tree,form</field>
<field name="view_id" ref="view_base_action_rule_history_tree"/>
</record>
<menuitem id="menu_base_action_rule_history_form" parent="menu_base_action_rule" action="base_action_rule_history_act"/>
</data>
</openerp>

View File

@ -0,0 +1,4 @@
"id","name","model_id:id","group_id:id","perm_read","perm_write","perm_create","perm_unlink"
"access_base_action_rule","base.action.rule","model_base_action_rule",,1,1,1,1
"access_base_action_rule_line","base.action.rule.line","model_base_action_rule_line",,1,1,1,1
"access_base_action_rule_history","base.action.rule.history","model_base_action_rule_history",,1,1,1,1
1 id name model_id:id group_id:id perm_read perm_write perm_create perm_unlink
2 access_base_action_rule base.action.rule model_base_action_rule 1 1 1 1
3 access_base_action_rule_line base.action.rule.line model_base_action_rule_line 1 1 1 1
4 access_base_action_rule_history base.action.rule.history model_base_action_rule_history 1 1 1 1