---
title: "lead_rule (Odoo)"
description: "itgen_odoo_lead_rule"
language: en
source_language: en
translation_state: complete
canonical: https://documentation.invantive.eu/en/datamodels/odoo/Odoo.event.lead_rule
original: https://documentation.invantive.eu/en/datamodels/odoo/Odoo.event.lead_rule
updated: 2023-03-01T15:29:04Z
license: https://documentation.invantive.eu/en/
---

# lead_rule: Odoo itgen_odoo_lead_rule

`read only` `per partition`

- Catalog: `Odoo`
- Schema: `event`
- Label: itgen_odoo_lead_rule

Event Lead Rules

Can only retrieve data.

## Summary

Rule model for creating / updating leads from event registrations.

    SPECIFICATIONS: CREATION TYPE

    There are two types of lead creation:

      * per attendee: create a lead for each registration;
      * per order: create a lead for a group of registrations;

    The last one is only available through interface if it is possible to register
    a group of attendees in one action (when event_sale or website_event are
    installed). Behavior itself is implemented directly in event_crm.

    Basically a group is either a list of registrations belonging to the same
    event and created in batch (website_event flow). With event_sale this
    definition will be improved to be based on sale_order.

    SPECIFICATIONS: CREATION TRIGGERS

    There are three options to trigger lead creation. We consider basically that
    lead quality increases if attendees confirmed or went to the event. Triggers
    allow therefore to run rules:

      * at attendee creation;
      * at attendee confirmation;
      * at attendee venue;

    This trigger defines when the rule will run.

    SPECIFICATIONS: FILTERING REGISTRATIONS

    When a batch of registrations matches the rule trigger we filter them based
    on conditions and rules defines on event_lead_rule model. Heuristic is the
    following:

      * the rule is active;
      * if a filter is set: filter registrations based on this filter. This is
        done like a search, and filter is a domain;
      * if a company is set on the rule, it must match event's company. Note
        that multi-company rules apply on event_lead_rule;
      * if an event category it set, it must match;
      * if an event is set, it must match;
      * if both event and category are set, one of them must match (OR). If none
        of those are set, it is considered as OK;

    If conditions are met, leads are created with pre-filled informations defined
    on the rule (type, user_id, team_id). Contact information coming from the
    registrations are computed (customer, name, email, phone, mobile, contact_name).

    SPECIFICATIONS: OTHER POINTS

    Note that all rules matching their conditions are applied. This means more
    than one lead can be created depending on the configuration. This is
    intended in order to give more freedom to the user using the automatic
    lead generation.

## Table Columns

The columns of the table `lead_rule` are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|:---:|---|---|
| `active` | `boolean` | Active | [ ] |  |  |
| `company_id` | `varchar2` |  | [ ] |  | Restrict the trigger of this rule to events belonging to a specific company. If not set, no company restriction will be applied. |
| `company_id_label` | `varchar2` |  | [ ] |  | Restrict the trigger of this rule to events belonging to a specific company. If not set, no company restriction will be applied. |
| `create_date` | `datetime` | Created on | [ ] |  |  |
| `create_uid` | `varchar2` |  | [ ] |  |  |
| `create_uid_label` | `varchar2` |  | [ ] |  |  |
| `display_name` | `varchar2` | Display Name | [ ] |  |  |
| `event_id` | `varchar2` |  | [ ] |  | Filter the attendees to include those of this specific event. If not set, no event restriction will be applied. |
| `event_id_label` | `varchar2` |  | [ ] |  | Filter the attendees to include those of this specific event. If not set, no event restriction will be applied. |
| `event_registration_filter` | `varchar2` | Registrations Domain | [ ] |  | Filter the attendees that will or not generate leads. |
| `event_type_ids` | `varchar2` |  | [ ] |  | Filter the attendees to include those of this specific event category. If not set, no event category restriction will be applied. |
| `id` | `int32` | ID | [ ] |  |  |
| `lead_creation_basis` | `varchar2` | Create | [x] |  | Per Attendee : A Lead is created for each Attendee (B2C). Per Order : A single Lead is created per Ticket Batch/Sale Order (B2B) |
| `lead_creation_trigger` | `varchar2` | When | [x] |  | Creation: at attendee creation; Confirmation: when attendee is confirmed, manually or automatically; Attended: when attendance is confirmed and registration set to done; |
| `lead_ids` | `varchar2` |  | [ ] |  |  |
| `lead_sales_team_id` | `varchar2` |  | [ ] |  | Automatically assign the created leads to this Sales Team. |
| `lead_sales_team_id_label` | `varchar2` |  | [ ] |  | Automatically assign the created leads to this Sales Team. |
| `lead_tag_ids` | `varchar2` |  | [ ] |  | Automatically add these tags to the created leads. |
| `lead_type` | `varchar2` | Lead Type | [x] |  | Default lead type when this rule is applied. |
| `lead_user_id` | `varchar2` |  | [ ] |  | Automatically assign the created leads to this Salesperson. |
| `lead_user_id_label` | `varchar2` |  | [ ] |  | Automatically assign the created leads to this Salesperson. |
| `name` | `varchar2` | Rule Name | [x] |  |  |
| `write_date` | `datetime` | Last Updated on | [ ] |  |  |
| `write_uid` | `varchar2` |  | [ ] |  |  |
| `write_uid_label` | `varchar2` |  | [ ] |  |  |



## Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver:

- [Odoo](/en/release-notes/drivers?driver=odoo)

