混入类和实用类¶

Odoo 实现了一些有用的类和混入（mixins），使您可以轻松地为对象添加常用行为。本指南将详细介绍其中大部分内容，并附带示例和用例。

消息功能¶

消息集成¶

基本消息系统¶

将消息功能集成到您的模型中非常简单。只需继承 mail.thread 混入类并在表单视图中添加聊天组件 <chatter/> 元素即可快速实现。聊天组件元素支持一些选项以控制表单行为：

open_attachments ：默认展开附件部分
reload_on_attachment ：在添加或删除附件时重新加载表单视图
reload_on_follower ：在更新关注者时重新加载表单视图
reload_on_post ：在发布新消息时重新加载表单视图

Example

让我们创建一个简单的模型来表示商务旅行。由于组织这种旅行通常涉及很多人和大量讨论，让我们为该模型添加消息交换支持。

class BusinessTrip(models.Model):
    _name = 'business.trip'
    _inherit = ['mail.thread']
    _description = 'Business Trip'

    name = fields.Char()
    partner_id = fields.Many2one('res.partner', 'Responsible')
    guest_ids = fields.Many2many('res.partner', 'Participants')

在表单视图中：

<record id="business_trip_form" model="ir.ui.view">
    <field name="name">business.trip.form</field>
    <field name="model">business.trip</field>
    <field name="arch" type="xml">
        <form string="Business Trip">
            <!-- Your usual form view goes here
            ...
            Then comes chatter integration with options you might want to set -->
            <chatter open_attachments="True"/>
        </form>
    </field>
</record>

一旦在模型中添加了聊天支持，用户可以轻松地在模型的任何记录上添加消息或内部注释；每条消息都会发送通知（对于消息会通知所有关注者，对于内部注释会通知员工用户组 (base.group_user)）。如果您的邮件网关和收件地址配置正确，这些通知将通过电子邮件发送，并且可以直接从邮件客户端回复；自动路由系统会将回复路由到正确的线程。

在服务器端，提供了一些辅助函数，可帮助您轻松发送消息并管理记录的关注者：

发布消息

message_post(self, body='', subject=None, message_type='notification', subtype=None, parent_id=False, attachments=None, **kwargs)¶

在现有线程中发布新消息，返回新的 mail.message ID。

参数

body (str | Markup) – 消息正文。如果是 str 类型，将被转义。对于 HTML 内容，请使用 Markup 对象。
message_type (str) – 参见 mail_message.message_type 字段
parent_id (int) – 在私密讨论的情况下，通过向消息中添加父级合作伙伴来处理对先前消息的回复
attachments (list(tuple(str,str))) – 附件元组列表，格式为 (name, content) ，其中 content 未进行 base64 编码
body_is_html (bool) – 指示是否应将 body 视为 HTML，即使它是 str 类型。
**kwargs – 额外的关键字参数将用作新 mail.message 记录的默认列值

返回

新创建的 mail.message 的 ID

返回类型

int

message_post_with_view(views_or_xmlid, **kwargs):

辅助方法，用于通过 view_id 使用 ir.qweb 引擎渲染并发送邮件/发布消息。此方法是独立的，因为模板和撰写器中没有任何内容可以批量处理视图。当模板能够处理 ir.ui.views 时，此方法可能会消失。

参数: record (str or ir.ui.view) – 应发送的视图的外部 ID 或记录

message_post_with_template(template_id, **kwargs)¶

使用模板发送邮件的辅助方法

参数

template_id – 用于渲染以创建消息正文的模板 ID
**kwargs – 用于创建 mail.compose.message 向导（继承自 mail.message）的参数

接收消息

当邮件网关处理新电子邮件时会调用这些方法。这些电子邮件可以是新线程（如果通过别名到达），也可以是现有线程的回复。重写它们允许根据电子邮件本身的某些值设置线程记录的值（例如更新日期或电子邮件地址、将抄送地址添加为关注者等）。

message_new(msg_dict, custom_values=None)¶

当收到针对特定线程模型的新消息且该消息不属于现有线程时，由 message_process 调用。

默认行为是基于从消息中提取的一些基本信息创建相应模型的新记录。可以通过重写此方法实现额外的行为。

参数

msg_dict (dict) – 包含电子邮件详细信息和附件的映射。详见 message_process 和 mail.message.parse
custom_values (dict) – 在创建新线程记录时传递给 create() 的可选字段值字典；请注意，这些值可能会覆盖来自消息的其他值

返回类型

int

返回

新创建的线程对象的 ID

message_update(msg_dict, update_vals=None)¶

当收到针对现有线程的新消息时，由 message_process 调用。默认行为是使用从传入电子邮件中提取的 update_vals 更新记录。

可以通过重写此方法实现额外的行为。

参数

msg_dict (dict) – 包含电子邮件详细信息和附件的映射；详见 message_process 和 mail.message.parse() 。
update_vals (dict) – 包含根据记录 ID 更新记录的值的字典；如果字典为 None 或为空，则不会执行写操作。

返回

True

关注者管理

message_subscribe(partner_ids=None, channel_ids=None, subtype_ids=None, force=True)¶

将合作伙伴添加为记录的关注者。

参数

partner_ids (list(int)) – 将订阅该记录的合作伙伴 ID
channel_ids (list(int)) – 将订阅该记录的频道 ID
subtype_ids (list(int)) – 频道/合作伙伴将订阅的子类型 ID（如果为 None ，则默认为默认子类型）
force – 如果为 True，在使用参数中的子类型创建新关注者之前删除现有的关注者

返回

成功/失败

返回类型

bool

message_unsubscribe(partner_ids=None, channel_ids=None)¶

从记录的关注者中移除合作伙伴。

参数

partner_ids (list(int)) – 将订阅该记录的合作伙伴 ID
channel_ids (list(int)) – 将订阅该记录的频道 ID

返回

True

返回类型

bool

message_unsubscribe_users(user_ids=None)¶

基于用户的 message_subscribe 包装器。

参数: user_ids (list(int)) – 将取消订阅该记录的用户 ID；如果为 None，则取消当前用户的订阅。
返回: True
返回类型: bool

记录更改¶

mail 模块为字段添加了一个强大的跟踪系统，允许您在记录的聊天记录中记录特定字段的更改。要为字段添加跟踪，只需将跟踪属性设置为 True。

Example

让我们跟踪商务旅行的名称和负责人的更改：

class BusinessTrip(models.Model):
    _name = 'business.trip'
    _inherit = ['mail.thread']
    _description = 'Business Trip'

    name = fields.Char(tracking=True)
    partner_id = fields.Many2one('res.partner', 'Responsible',
                                 tracking=True)
    guest_ids = fields.Many2many('res.partner', 'Participants')

从现在开始，每次对旅行名称或负责人的更改都会在记录中记录一条备注。即使名称未更改，name 字段也会显示在通知中，以提供更多上下文信息。

子类型¶

子类型为您提供对消息更精细的控制。子类型充当通知的分类系统，允许文档的订阅者自定义他们希望接收的通知子类型。

子类型作为数据在您的模块中创建；该模型具有以下字段：

name （必填） - Char: 子类型的名称，将显示在通知自定义弹出窗口中
description - Char: 将添加到为此子类型发布的消息中的描述。如果为空，则会添加名称
internal - Boolean: 具有内部子类型的消息仅对员工可见，即 base.group_user 组的成员
parent_id - Many2one: 通过此链接关联子类型以实现自动订阅；例如，项目子类型通过此链接与任务子类型关联。当有人订阅了某个项目时，他将通过父级子类型找到的任务子类型订阅该项目的所有任务
relation_field - Char: 例如，在关联项目和任务子类型时，关系字段是任务的 project_id 字段
res_model - Char: 子类型适用的模型；如果为 False，则此子类型适用于所有模型
default - Boolean: 是否在订阅时默认激活子类型
sequence - Integer: 用于在通知自定义弹出窗口中对子类型进行排序
hidden - Boolean: 子类型是否隐藏在通知自定义弹出窗口中

通过字段跟踪与子类型交互，可以根据用户的兴趣订阅不同种类的通知。为此，您可以重写 _track_subtype() 函数：

_track_subtype(init_values)¶

根据已更新的值，给出由记录上的更改触发的子类型。

参数: init_values (dict) – 记录的原始值；字典中仅包含已修改的字段
返回: 子类型的完整外部 ID，如果没有触发子类型则为 False

Example

让我们在示例类中添加一个 state 字段，并在该字段值发生更改时触发特定子类型的通知。

首先，让我们定义我们的子类型：

<record id="mt_state_change" model="mail.message.subtype">
    <field name="name">Trip confirmed</field>
    <field name="res_model">business.trip</field>
    <field name="default" eval="True"/>
    <field name="description">Business Trip confirmed!</field>
</record>

然后，我们需要重写 track_subtype() 函数。此函数由跟踪系统调用，用于根据当前应用的更改确定应使用的子类型。在我们的例子中，当 state 字段从 draft 变为 confirmed 时，我们希望使用新的子类型：

class BusinessTrip(models.Model):
    _name = 'business.trip'
    _inherit = ['mail.thread']
    _description = 'Business Trip'

    name = fields.Char(tracking=True)
    partner_id = fields.Many2one('res.partner', 'Responsible',
                                 tracking=True)
    guest_ids = fields.Many2many('res.partner', 'Participants')
    state = fields.Selection([('draft', 'New'), ('confirmed', 'Confirmed')],
                             tracking=True)

    def _track_subtype(self, init_values):
        # init_values contains the modified fields' values before the changes
        #
        # the applied values can be accessed on the record as they are already
        # in cache
        self.ensure_one()
        if 'state' in init_values and self.state == 'confirmed':
            return self.env.ref('my_module.mt_state_change')
        return super(BusinessTrip, self)._track_subtype(init_values)

自定义通知¶

在向关注者发送通知时，在模板中添加按钮以允许直接从电子邮件执行快速操作非常有用。即使是简单的按钮，直接链接到记录的表单视图也可能很有用；然而，在大多数情况下，您不希望向门户用户显示这些按钮。

通知系统允许通过以下方式自定义通知模板：

显示 访问按钮：这些按钮显示在通知电子邮件的顶部，允许收件人直接访问记录的表单视图
显示 关注按钮：这些按钮允许收件人直接快速订阅记录
显示 取消关注按钮：这些按钮允许收件人直接快速取消订阅记录
显示 自定义操作按钮：这些按钮调用特定路由，并允许您通过电子邮件直接执行一些有用的操作（例如，将潜在客户转换为机会、验证费用表以供费用管理员使用等）

这些按钮设置可以应用于不同的组，您可以通过重写函数 _notify_get_groups 自己定义这些组。

_notify_get_groups(message, groups)¶

根据已更新的值，给出由记录上的更改触发的子类型。

参数

message (record) – 当前正在发送的 mail.message 记录
groups (list(tuple)) – 形式为 (group_name, group_func, group_data) 的元组列表，其中：group_name 是仅用于覆盖和操作组的标识符。默认组包括 user （与员工用户关联的收件人）、portal （与门户用户关联的收件人）和 customer （未与任何用户关联的收件人）。覆盖的一个示例是添加一个与 res.groups 关联的组，例如人力资源官员组，以便为其设置特定的操作按钮。group_func 是一个接受合作伙伴记录作为参数的函数指针。此方法将应用于收件人，以确定他们是否属于某个组。仅保留第一个匹配的组。评估顺序为列表顺序。group_data 是一个包含通知电子邮件参数的字典，可能的键值如下：- has_button_access 是否在电子邮件中显示访问文档按钮。对于新组默认为 True，对于门户/客户为 False。- button_access 包含按钮 URL 和标题的字典。- has_button_follow 是否在电子邮件中显示关注按钮（如果收件人当前未关注线程）。对于新组默认为 True，对于门户/客户为 False。- button_follow 包含按钮 URL 和标题的字典。- has_button_unfollow 是否在电子邮件中显示取消关注按钮（如果收件人当前正在关注线程）。对于新组默认为 True，对于门户/客户为 False。- button_unfollow 包含按钮 URL 和标题的字典。- actions 要在通知电子邮件中显示的操作按钮列表。每个操作是一个包含按钮 URL 和标题的字典。

返回

子类型的完整外部 ID，如果没有触发子类型则为 False

操作列表中的 URL 可以通过调用 _notify_get_action_link() 函数自动生成：

_notify_get_action_link(self, link_type, **kwargs)¶

为当前记录生成指定类型的链接（如果设置了 kwargs model 和 res_id ，则针对特定记录生成）。

参数: link_type (str) – 要生成的链接类型；可以是以下值之一： view 链接到记录的表单视图； assign 将当前登录用户分配到记录的 user_id 字段（如果存在）； follow 自我解释； unfollow 自我解释； method 调用记录上的方法；方法名称应作为 kwarg method 提供；new 打开一个空的表单视图以创建新记录；您可以通过在 kwarg action_id 中提供特定动作的 ID（数据库 ID 或完全解析的外部 ID）来指定特定动作。
返回: 为记录选择的链接类型
返回类型: str

Example

让我们为商务旅行状态变更通知添加一个自定义按钮；该按钮将状态重置为草稿，并且仅对（假设的）旅行经理组 (business.group_trip_manager) 的成员可见。

class BusinessTrip(models.Model):
    _name = 'business.trip'
    _inherit = ['mail.thread', 'mail.alias.mixin']
    _description = 'Business Trip'

    # Pevious code goes here

    def action_cancel(self):
        self.write({'state': 'draft'})

    def _notify_get_groups(self, message, groups):
        """ Handle Trip Manager recipients that can cancel the trip at the last
        minute and kill all the fun. """
        groups = super(BusinessTrip, self)._notify_get_groups(message, groups)

        self.ensure_one()
        if self.state == 'confirmed':
            app_action = self._notify_get_action_link('method',
                                method='action_cancel')
            trip_actions = [{'url': app_action, 'title': _('Cancel')}]

        new_group = (
            'group_trip_manager',
            lambda partner: any(
                user.sudo().has_group('business.group_trip_manager')
                for user in partner.user_ids
            ),
            {'actions': trip_actions},
        )

        return [new_group] + groups

请注意，我本可以在方法外部定义我的评估函数，并定义一个全局函数来代替使用 lambda 表达式，但为了在这些文档文件中更加简洁并减少冗长（有时会显得枯燥），我选择了前者而不是后者。

覆盖默认值¶

有多种方法可以自定义 mail.thread 模型的行为，包括但不限于：

_mail_post_access - Model 属性

在模型上发布消息所需的访问权限；默认需要 write 访问权限，也可以设置为 read

上下文键：

这些上下文键可用于在调用 create() 或 write()``（或任何其他可能有用的方法）期间控制 ``mail.thread 的功能，例如自动订阅或字段跟踪。

mail_create_nosubscribe ：在创建或 message_post 时，不要将当前用户订阅到记录线程
mail_create_nolog ：在创建时，不要记录自动生成的“<文档>已创建”消息
mail_notrack ：在创建和写入时，不要执行值跟踪以生成消息
tracking_disable: at create and write, perform no MailThread features (auto subscription, tracking, post, …)
mail_auto_delete ：自动删除邮件通知；默认为 True
mail_notify_force_send ：如果少于 50 封电子邮件通知，则直接发送而不是使用队列；默认为 True
mail_notify_user_signature ：在电子邮件通知中添加当前用户签名；默认为 True

邮件别名¶

别名是可配置的电子邮件地址，与特定记录（通常继承 mail.alias.mixin 模型）相关联，当通过电子邮件联系时会创建新记录。它们是一种让系统从外部访问的简便方法，允许用户或客户快速在数据库中创建记录，而无需直接连接到 Odoo。

别名与传入邮件网关的对比¶

有些人出于相同目的使用传入邮件网关。尽管如此，使用别名仍然需要正确配置的邮件网关，但单个收件域名就足够了，因为所有路由都将在 Odoo 内部完成。别名相比邮件网关有几个优点：

更易于配置
- 单个传入网关可以被多个别名使用；这避免了在域名上配置多个电子邮件（所有配置都在 Odoo 内部完成）。
- 配置别名不需要系统访问权限
更加一致
- 可在相关记录上配置，而不是在设置子菜单中配置
更容易在服务器端重写
- Mixin 模型从一开始就被设计为可扩展，使您可以比使用邮件网关更轻松地从传入电子邮件中提取有用数据。

别名支持集成¶

别名通常配置在父模型上，当通过电子邮件联系时会创建特定记录。例如，项目有用于创建任务或问题的别名，销售团队有用于生成潜在客户的别名。

注解

别名创建的模型必须继承 mail_thread 模型。

通过继承 mail.alias.mixin 添加别名支持；此 mixin 将为每个创建的父类记录生成一个新的 mail.alias 记录（例如，每个 project.project 记录在创建时都会初始化其 mail.alias 记录）。

注解

别名也可以手动创建，并由简单的 Many2one 字段支持。本指南假设您希望实现更完整的集成，包括别名的自动创建、记录特定的默认值等。

与 mail.thread 继承不同， mail.alias.mixin 需要一些特定的重写才能正常工作。这些重写将指定创建的别名的值，例如它必须创建的记录类型以及根据父对象可能具有的某些默认值：

_get_alias_model_name(vals)¶

返回别名的模型名称。非回复现有记录的传入电子邮件将导致创建此别名模型的新记录。该值可能取决于 vals ，即在创建此模型的记录时传递给 create 的值字典。

参数: dict (vals) – 将持有别名的新创建记录的值
返回: 模型名称
返回类型: str

_get_alias_values()¶

返回创建别名的值，或在别名创建后写入别名的值。虽然不是完全强制性的，但通常需要确保新创建的记录通过在别名的 alias_defaults 字段中设置默认值字典来链接到别名的父对象（例如，在正确的项目中创建任务）。

返回: 将写入新别名的值字典
返回类型: dict

_get_alias_values() 重写特别有趣，因为它允许您轻松修改别名的行为。在别名上可以设置的字段中，以下字段尤其值得关注：

alias_name - Char

电子邮件别名的名称，例如，如果您希望捕获 <jobs@example.odoo.com> 的电子邮件，则名称为 ‘jobs’

alias_user_id - Many2one (res.users)

接收此别名电子邮件时创建记录的所有者；如果未设置该字段，系统将尝试根据发件人（发件地址）找到合适的所有者，如果未找到对应系统用户，则使用管理员账户。

alias_defaults - Text

Python 字典，将在为该别名创建新记录时被评估以提供默认值

alias_force_thread_id - Integer

可选的线程（记录）ID，所有传入消息都将附加到该线程，即使它们未回复它；如果设置此值，将完全禁用新记录的创建

alias_contact - Selection

使用邮件网关在文档上发布消息的策略

所有人：每个人都可以发布
合作伙伴：仅限已认证的合作伙伴
关注者：仅限相关文档的关注者或关注频道的成员

请注意，别名使用了委托继承，这意味着虽然别名存储在另一个表中，但您可以直接从父对象访问所有这些字段。这使您可以轻松地从记录的表单视图中配置别名。

Example

让我们为商务旅行类添加别名，以便通过电子邮件即时创建费用。

class BusinessTrip(models.Model):
    _name = 'business.trip'
    _inherit = ['mail.thread', 'mail.alias.mixin']
    _description = 'Business Trip'

    name = fields.Char(tracking=True)
    partner_id = fields.Many2one('res.partner', 'Responsible',
                                 tracking=True)
    guest_ids = fields.Many2many('res.partner', 'Participants')
    state = fields.Selection([('draft', 'New'), ('confirmed', 'Confirmed')],
                             tracking=True)
    expense_ids = fields.One2many('business.expense', 'trip_id', 'Expenses')
    alias_id = fields.Many2one('mail.alias', string='Alias', ondelete="restrict",
                               required=True)

    def _get_alias_model_name(self, vals):
    """ Specify the model that will get created when the alias receives a message """
        return 'business.expense'

    def _get_alias_values(self):
    """ Specify some default values that will be set in the alias at its creation """
        values = super(BusinessTrip, self)._get_alias_values()
        # alias_defaults holds a dictionary that will be written
        # to all records created by this alias
        #
        # in this case, we want all expense records sent to a trip alias
        # to be linked to the corresponding business trip
        values['alias_defaults'] = {'trip_id': self.id}
        # we only want followers of the trip to be able to post expenses
        # by default
        values['alias_contact'] = 'followers'
        return values

class BusinessExpense(models.Model):
    _name = 'business.expense'
    _inherit = ['mail.thread']
    _description = 'Business Expense'

    name = fields.Char()
    amount = fields.Float('Amount')
    trip_id = fields.Many2one('business.trip', 'Business Trip')
    partner_id = fields.Many2one('res.partner', 'Created by')

我们希望可以从商务旅行的表单视图中轻松配置别名，因此让我们在表单视图中添加以下内容：

<page string="Emails">
    <group name="group_alias">
        <label for="alias_name" string="Email Alias"/>
        <div name="alias_def">
            <!-- display a link while in view mode and a configurable field
            while in edit mode -->
            <field name="alias_id" class="oe_read_only oe_inline"
                    string="Email Alias" required="0"/>
            <div class="oe_edit_only oe_inline" name="edit_alias"
                 style="display: inline;" >
                <field name="alias_name" class="oe_inline"/>
                @
                <field name="alias_domain" class="oe_inline" readonly="1"/>
            </div>
        </div>
        <field name="alias_contact" class="oe_inline"
                string="Accept Emails From"/>
    </group>
</page>

现在我们可以直接从表单视图中更改别名地址，并更改谁可以向别名发送电子邮件。

然后，我们可以在费用模型中重写 message_new()，以便在创建费用时从电子邮件中获取值：

class BusinessExpense(models.Model):
    # Previous code goes here
    # ...

    def message_new(self, msg, custom_values=None):
        """ Override to set values according to the email.

        In this simple example, we simply use the email title as the name
        of the expense, try to find a partner with this email address and
        do a regex match to find the amount of the expense."""
        name = msg_dict.get('subject', 'New Expense')
        # Match the last occurrence of a float in the string
        # Example: '50.3 bar 34.5' becomes '34.5'. This is potentially the price
        # to encode on the expense. If not, take 1.0 instead
        amount_pattern = '(\d+(\.\d*)?|\.\d+)'
        expense_price = re.findall(amount_pattern, name)
        price = expense_price and float(expense_price[-1][0]) or 1.0
        # find the partner by looking for it's email
        partner = self.env['res.partner'].search([('email', 'ilike', email_address)],
                                                 limit=1)
        defaults = {
            'name': name,
            'amount': price,
            'partner_id': partner.id
        }
        defaults.update(custom_values or {})
        res = super(BusinessExpense, self).message_new(msg, custom_values=defaults)
        return res

活动跟踪¶

活动是用户需要对文档执行的操作，例如拨打电话或组织会议。活动随邮件模块一起提供，因为它们集成在聊天记录中，但 不与 mail.thread 捆绑。活动是 mail.activity 类的记录，具有类型（ mail.activity.type ）、名称、描述、计划时间（以及其他属性）。待处理的活动在聊天记录小部件的消息历史记录上方可见。

您可以使用 mail.activity.mixin 类在对象上集成活动，并通过特定的小部件（通过字段 activity_ids ）在记录的表单视图和看板视图中显示它们（分别为 mail_activity 和 kanban_activity 小部件）。

Example

组织商务旅行是一个繁琐的过程，跟踪所需的活动（如订购机票或预订机场出租车）可能会很有用。为此，我们将在模型中添加活动混入，并在旅行的消息历史记录中显示下一个计划的活动。

class BusinessTrip(models.Model):
    _name = 'business.trip'
    _inherit = ['mail.thread', 'mail.activity.mixin']
    _description = 'Business Trip'

    name = fields.Char()
    # [...]

我们修改旅行的表单视图以显示其下一个活动：

<record id="business_trip_form" model="ir.ui.view">
    <field name="name">business.trip.form</field>
    <field name="model">business.trip</field>
    <field name="arch" type="xml">
        <form string="Business Trip">
            <!-- Your usual form view goes here -->
            <chatter>
                <field name="message_follower_ids" widget="mail_followers"/>
                <field name="activity_ids" widget="mail_activity"/>
                <field name="message_ids" widget="mail_thread"/>
            </chatter>
        </form>
    </field>
</record>

您可以在以下模型中找到具体的集成示例：

CRM（crm）应用中的 crm.lead
销售（sale）应用中的 sale.order
项目（project）应用中的 project.task

网站功能¶

访客跟踪¶

utm.mixin 类可用于通过链接到指定资源的参数来跟踪在线营销/传播活动。该混入类为您的模型添加了 3 个字段：

campaign_id：指向 utm.campaign 对象的 Many2one 字段（例如 Christmas_Special、Fall_Collection 等）
source_id ：指向 utm.source 对象的 Many2one 字段（例如搜索引擎、邮件列表等）
medium_id ：指向 utm.medium 对象的 Many2one 字段（例如平邮、电子邮件、社交网络更新等）

这些模型只有一个字段 name （即它们只是用来区分活动，但没有任何特定行为）。

当客户访问您的网站时，如果 URL 中设置了这些参数（例如 https://www.odoo.com/?campaign_id=mixin_talk&source_id=www.odoo.com&medium_id=website），则会在访问者的网站中为这些参数设置三个 Cookie。一旦从网站创建了继承自 utm.mixin 的对象（例如潜在客户表单、职位申请等），utm.mixin 代码会启动并从 Cookie 中获取值以将其设置到新记录中。完成后，您可以像使用其他字段一样，在定义报表和视图时使用活动/来源/媒介字段（分组等）。

要扩展此行为，只需向简单模型添加一个关系字段（该模型应支持 快速创建 （即调用 create() 方法时仅传递一个 name 值）），并扩展函数 tracking_fields() ：

class UtmMyTrack(models.Model):
    _name = 'my_module.my_track'
    _description = 'My Tracking Object'

    name = fields.Char(string='Name', required=True)


class MyModel(models.Models):
    _name = 'my_module.my_model'
    _inherit = ['utm.mixin']
    _description = 'My Tracked Object'

    my_field = fields.Many2one('my_module.my_track', 'My Field')

    @api.model
    def tracking_fields(self):
        result = super(MyModel, self).tracking_fields()
        result.append([
        # ("URL_PARAMETER", "FIELD_NAME_MIXIN", "NAME_IN_COOKIES")
            ('my_field', 'my_field', 'odoo_utm_my_field')
        ])
        return result

这将告诉系统创建一个名为 odoo_utm_my_field 的 Cookie，其值来自 URL 参数 my_field ；一旦通过网站表单调用创建了该模型的新记录，utm.mixin 的 create() 方法的通用重写将从 Cookie 中获取该字段的默认值（如果 my_module.my_track 记录尚不存在，则会动态创建）。

您可以在以下模型中找到具体的集成示例：

CRM（crm）应用中的 crm.lead
招聘流程 (hr_recruitment) 应用中的 hr.applicant
帮助台 (helpdesk - 仅限 Odoo Enterprise) 应用中的 helpdesk.ticket

网站可见性¶

您可以非常轻松地在任何记录上添加网站可见性开关。尽管手动实现此混入类非常容易，但它是最常用的混入类之一，仅次于 mail.thread 继承；这证明了它的实用性。此混入类的典型用例是任何具有前端页面的对象；能够控制页面的可见性，使您可以在编辑页面时从容不迫，并仅在满意时发布它。

要包含此功能，您只需继承 website.published.mixin ：

class BlogPost(models.Model):
    _name = "blog.post"
    _description = "Blog Post"
    _inherit = ['website.published.mixin']

此混入类在您的模型中添加了两个字段：

website_published ：表示发布状态的 Boolean 字段
website_url ：表示对象访问 URL 的 Char 字段

请注意，此最后一个字段是一个计算字段，必须为您类进行实现：

def _compute_website_url(self):
    for blog_post in self:
        blog_post.website_url = "/blog/%s" % (log_post.blog_id)

一旦机制就位，您只需调整前端和后端视图以使其可用。在后端，通常的做法是在按钮框中添加一个按钮：

<button class="oe_stat_button" name="website_publish_button"
    type="object" icon="fa-globe">
    <field name="website_published" widget="website_button"/>
</button>

在前端，需要进行一些安全检查以避免向网站访客显示“编辑”按钮：

<div id="website_published_button" class="float-right"
     groups="base.group_website_publisher"> <!-- or any other meaningful group -->
    <t t-call="website.publish_management">
      <t t-set="object" t-value="blog_post"/>
      <t t-set="publish_edit" t-value="True"/>
      <t t-set="action" t-value="'blog.blog_post_action'"/>
    </t>
</div>

请注意，您必须将对象作为变量 object 传递给模板；在此示例中，blog.post 记录作为 blog_post 变量传递给了 qweb 渲染引擎，必须将其指定给发布管理模板。 publish_edit 变量允许前端按钮链接到后端（使您可以轻松从前端切换到后端，反之亦然）；如果已设置，则必须在 action 变量中指定要在后端调用的操作的完整外部 ID（请注意，模型必须存在表单视图）。

操作 website_publish_button 在混入类中定义，并根据您的对象调整其行为：如果类具有有效的 website_url 计算函数，则用户点击按钮时会被重定向到前端；然后用户可以直接从前端发布页面。这确保不会意外发生在线发布。如果没有计算函数，则仅触发布尔值 website_published 。

网站元数据¶

这个简单的混入类允许您轻松地将元数据注入到前端页面中。

class BlogPost(models.Model):
    _name = "blog.post"
    _description = "Blog Post"
    _inherit = ['website.seo.metadata', 'website.published.mixin']

此混入类在您的模型中添加了三个字段：

website_meta_title: Char field that allow you to set an additional title to your page
website_meta_description ： Char 字段，包含页面的简短描述（有时用于搜索引擎结果中）
website_meta_keywords ： Char 字段，包含一些关键词，以帮助您的页面被搜索引擎更精确地分类；“推广”工具将帮助您轻松选择语义相关的关键词

这些字段可以通过编辑器工具栏中的“推广”工具在前端进行编辑。设置这些字段可以帮助搜索引擎更好地索引您的页面。请注意，搜索引擎的结果不仅仅基于这些元数据；最佳的 SEO 实践仍然是通过可靠的来源获得引用。

其他¶

客户评分¶

评分混入类允许发送电子邮件请求客户评分、在看板流程中自动过渡以及对评分进行统计汇总。

在模型中添加评分功能¶

要添加评分支持，只需继承 rating.mixin 模型：

class MyModel(models.Models):
    _name = 'my_module.my_model'
    _inherit = ['rating.mixin', 'mail.thread']

    user_id = fields.Many2one('res.users', 'Responsible')
    partner_id = fields.Many2one('res.partner', 'Customer')

混入类的行为会根据您的模型进行调整：

rating.rating 记录将链接到模型的 partner_id 字段（如果该字段存在）。
- 如果您使用了其他字段而非 partner_id，可以通过函数 rating_get_partner_id() 覆盖此行为
rating.rating 记录将链接到模型的 user_id 字段对应的合作伙伴（如果该字段存在）（即被评分的合作伙伴）
- 如果您使用了其他字段而非 user_id ，可以通过函数 rating_get_rated_partner_id() 覆盖此行为（请注意，该函数必须返回一个 res.partner ，对于 user_id ，系统会自动获取用户的合作伙伴）
聊天记录历史将显示评分事件（如果您的模型继承自 mail.thread ）

通过电子邮件发送评分请求¶

如果您希望发送电子邮件请求评分，只需生成一封包含评分对象链接的电子邮件。一个非常基础的邮件模板可能如下所示：

<record id="rating_my_model_email_template" model="mail.template">
            <field name="name">My Model: Rating Request</field>
            <field name="email_from">${object.rating_get_rated_partner_id().email or '' | safe}</field>
            <field name="subject">Service Rating Request</field>
            <field name="model_id" ref="my_module.model_my_model"/>
            <field name="partner_to" >${object.rating_get_partner_id().id}</field>
            <field name="auto_delete" eval="True"/>
            <field name="body_html"><![CDATA[
% set access_token = object.rating_get_access_token()
<p>Hi,</p>
<p>How satsified are you?</p>
<ul>
    <li><a href="/rate/${access_token}/5">Satisfied</a></li>
    <li><a href="/rate/${access_token}/3">Okay</a></li>
    <li><a href="/rate/${access_token}/1">Dissatisfied</a></li>
</ul>
]]></field>
</record>

您的客户将收到一封电子邮件，其中包含指向简单网页的链接，允许他们对与您的用户互动提供反馈（包括自由文本反馈消息）。

然后，您可以非常轻松地通过为评分定义操作，将评分集成到表单视图中：

<record id="rating_rating_action_my_model" model="ir.actions.act_window">
    <field name="name">Customer Ratings</field>
    <field name="res_model">rating.rating</field>
    <field name="view_mode">kanban,pivot,graph</field>
    <field name="domain">[('res_model', '=', 'my_module.my_model'), ('res_id', '=', active_id), ('consumed', '=', True)]</field>
</record>

<record id="my_module_my_model_view_form_inherit_rating" model="ir.ui.view">
    <field name="name">my_module.my_model.view.form.inherit.rating</field>
    <field name="model">my_module.my_model</field>
    <field name="inherit_id" ref="my_module.my_model_view_form"/>
    <field name="arch" type="xml">
        <xpath expr="//div[@name='button_box']" position="inside">
            <button name="%(rating_rating_action_my_model)d" type="action"
                    class="oe_stat_button" icon="fa-smile-o">
                <field name="rating_count" string="Rating" widget="statinfo"/>
            </button>
        </xpath>
    </field>
</record>

请注意，评分有默认视图（看板、透视表、图表），可以让您快速概览客户的评分情况。

您可以在以下模型中找到具体的集成示例：

项目（rating_project）应用中的 project.task
帮助台 (helpdesk - 仅限 Odoo Enterprise) 应用中的 helpdesk.ticket

Edit on GitHub