Digest emails¶

Digest Emails are periodic snapshots sent via email to users in an organization that include high-level information about how the business is performing.

To start sending digest emails, begin by navigating to Settings app ‣ Statistics section, activate the Digest Emails feature, and click Save.

screenshot: general-digest-settings

menu: Settings ‣ General Settings ‣ Statistics
shows: The Statistics section with the "Digest Emails" checkbox ticked, the Digest Email field set to "Your Odoo Periodic Digest", and the "Configure Digest Emails" link.
highlight: The Digest Emails setting.
module: digest
notes: English UI, crop to the section.

A variety of settings can be configured for digest emails, such as:

Deciding which KPIs are shared in the digest emails
Determining how often digest emails are sent
Choosing who in the organization receives digest emails
Creating custom digest email templates
Adding additional KPIs (custom development required)

Note

By default, the Digest Email feature is enabled. Your Odoo Periodic Digest serves as the primary template, which includes all KPI measurements across the Odoo database, and is sent daily to administrators.

Warning

When creating duplicates of databases that have sending capabilities (not testing-mode), the digest emails continue to send from the duplicate database, unless deactivated.

To deactivate the digest email, navigate to Settings ‣ Statistics section. Then, deactivate the Digest Emails feature, by un-ticking the checkbox, and clicking Save. See the section on Deactivate digest email.

Customize default digest email¶

To customize the default digest email (Your Odoo Periodic Digest), go to Settings app ‣ Statistics section ‣ Digest Email field. Then, select Your Odoo Periodic Digest, and click on the ↗️ (External link) icon, next to the drop-down menu selection.

A pop-up window appears, and presents a variety of editable settings, which include:

Digest Title: the name of the digest email.
Periodicity: control how often digest emails are sent (Daily, Weekly, Monthly, or Quarterly).
Next Mailing Date: the date on which the digest email will be sent again.
KPIs tab: check/uncheck each calculated KPI that appears in digest emails. A ticked box indicates an active KPI in the digest email. See the section on KPIs.
Recipients tab: add/remove users who receive the digest emails. See the section on Recipients.

Note

Additional KPIs can be added with a custom module. See this section on Custom KPIs.

screenshot: general-digest-form

menu: Settings ‣ General Settings ‣ Statistics ‣ Digest Email ‣ (internal link)
shows: The "Your Odoo Periodic Digest" form: Digest Title, Periodicity, Next Mailing Date, and the KPIs tab with checkboxes grouped by app.
highlight: The KPIs tab.
module: digest
notes: English UI, crop to the form sheet.

Deactivate digest email¶

To manually deactivate an individual digest email, first navigate to Settings app ‣ Statistics section, and click Configure Digest Emails. Then, select the desired digest email from the list that should be deactivated.

Next, click Deactivate to deactivate the digest email for everyone. A deactivated digest can be reactivated with the Activate button. Both buttons are located at the top of the form, next to the Send Now button, which sends the digest immediately.

Tip

A recipient can stop receiving a digest by clicking the Unsubscribe link at the bottom of the digest email.

Manually send digest email¶

To manually send a digest email, first navigate to Settings app ‣ Statistics section, and click Configure Digest Emails. Then, select the desired digest email, and click SEND NOW. This button is located in the top menu, just above the Digest Name.

KPIs¶

Pre-configured KPIs can be added to the digest email from the KPIs tab of the digest email template form.

First, navigate to Settings app ‣ Statistics section, and click Configure Digest Emails.

Then, select the desired digest email, and open the KPIs tab.

To add a KPI to the digest email, tick the checkbox next to the desired KPI. After all KPIs are added (or deselected), click Save.

The following KPIs are available in the KPIs tab on a digest email template form out-of-box in Odoo:

screenshot: general-digest-kpis

menu: Settings ‣ Statistics ‣ Configure Digest Emails ‣ (digest)
shows: The KPIs tab of a digest listing the available KPIs grouped under General, Project, Recruitment, CRM, Sales, Point of Sale, Live Chat and Invoicing.
module: digest
notes: English UI, crop to the KPIs tab; displayed on the right of the list.

General

Connected Users
Messages Sent

Project

Open Tasks

Recruitment

New Employees

CRM

New Leads
Opportunities Won

Sales

All Sales
eCommerce Sales

Point of Sale

POS Sales

Live Chat

% of Happiness
Conversations handled
Time to answer (sec)

Invoicing

Revenue

Note

The KPIs of an app are only available if the app is installed.

Recipients¶

Digest email recipients are added from the Recipients tab of the digest email template form.

To add a recipient, navigate to Settings app ‣ Statistics section, and click Configure Digest Emails. Then, select the desired digest email, and open the Recipients tab.

To add a recipient, click Add a line, and an Add Recipients pop-up window appears, with all available users to add as recipients.

From the pop-up window, tick the checkbox next to the Name of the user(s), and click the Select button.

To remove a user as a recipient, click the ❌ (remove) icon to the far-right of the user listed in the Recipients tab.

Click Save to implement the changes.

Create digest emails¶

To create a new digest email, navigate to Settings app ‣ Statistics section, and click Configure Digest Emails. Then, click New to create a new digest email.

A separate page, with a blank digest email template appears, and presents a variety of editable settings, including:

Digest Title: the name of the digest email.
Periodicity: control how often digest emails are sent (Daily, Weekly, Monthly, or Quarterly).
Next Mailing Date: the date on which the digest email will be sent again.
KPIs tab: check/uncheck each calculated KPI that appears in digest emails. A ticked box indicates an active KPI in the digest email. See the section on KPIs.
Recipients tab: add/remove users who receive the digest emails. See the section on Recipients.

From there, give the digest email a Digest Title, specify Periodicity, choose the desired KPIs, and add Recipients, as needed.

After clicking Save, the new custom digest email is available as a selection in the Digest Email field, located in the Settings app ‣ Statistics section.

Custom KPIs¶

Additional KPIs can be added to the KPIs tab of the digest email template form by a developer, in a custom module. For each new KPI, two fields are needed on the digest model (digest.digest):

A boolean field, e.g., kpi_myfield, displayed in the KPIs tab, to enable the KPI.
A computed field, e.g., kpi_myfield_value, that computes the value of the KPI.

Once the module is installed, the new KPI can be selected in the KPIs tab.

Tip

The digest.py file of the Digest module (digest/models/digest.py) and the modules that add the standard KPIs (e.g., crm, sale, project) can be used as examples for the computed fields.

Computed values reference table¶

LABEL	VALUE
Connected Users	`kpi_res_users_connected_value`
Messages Sent	`kpi_mail_message_total_value`
New Leads	`kpi_crm_lead_created_value`
Opportunities Won	`kpi_crm_opportunities_won_value`
Open Tasks	`kpi_project_task_opened_value`
% of Happiness	`kpi_livechat_rating_value`
Conversations handled	`kpi_livechat_conversations_value`
Time to answer (sec)	`kpi_livechat_response_value`
All Sales	`kpi_all_sale_total_value`
eCommerce Sales	`kpi_website_sale_total_value`
Revenue	`kpi_account_total_revenue_value`
POS Sales	`kpi_pos_total_value`
New Employees	`kpi_hr_recruitment_new_colleagues_value`