Skip to content

Commit bab2a36

Browse files
[ADD] general/digest_emails: add new digest emails docs
1 parent f220a30 commit bab2a36

File tree

4 files changed

+118
-1
lines changed

4 files changed

+118
-1
lines changed

content/applications/general.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Miscellaneous
1111
general/email_communication
1212
general/voip
1313
general/calendars
14+
general/digest_emails
1415
general/in_app_purchase
1516
general/developer_mode
16-
17+
Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
:show-content:
2+
3+
=============
4+
Digest Emails
5+
=============
6+
7+
**Digest Emails** are periodic snapshots sent to your organization via email that include high-level
8+
information about how your business is performing.
9+
10+
Navigate to Digest Emails by going to :menuselection:`Settings --> General Settings --> Statistics`,
11+
then activate the **Digest Emails** feature and click on save.
12+
13+
.. image:: digest_emails/digest-email-settings.png
14+
:align: center
15+
:alt: Digest Emails section inside General Settings.
16+
17+
You can control a variety of settings for your Digest Emails, such as:
18+
19+
- which KPIs are shared in the Digest
20+
- how often Digest Emails are sent
21+
- who in your organization receives Digest Emails
22+
- creating custom Digest Email templates
23+
- adding additional KPIs (Studio required)
24+
25+
.. note::
26+
By default, Digest Email is *enabled*, and *Your Odoo Periodic Digest* serves as the primary
27+
template, which includes all KPI measurements across your Odoo database and is sent daily to
28+
administrators.
29+
30+
.. _digest-emails/customize-digest:
31+
32+
Customize *Your Odoo Periodic Digest*
33+
=====================================
34+
35+
To customize the default Digest Email (*Your Odoo Periodic Digest*), go to :menuselection:`Settings
36+
--> General Settings --> Statistics --> Digest Email`, select *Your Odoo Periodic Digest* and click
37+
on the *external link* next to the dropdown selection.
38+
39+
A popup window appears and presents a variety of editable settings, which include:
40+
41+
- **Digest Title** - what you want your Digest Email to be called
42+
- **Periodicity** - control the regimen in how often Digest Emails are sent
43+
- **KPIs** - check/uncheck each calculated KPI that appears in Digest Emails
44+
- **Recipients** - add/remove users who receive your Digest Emails
45+
- **Custom** - add your own KPIs (Studio required)
46+
47+
.. image:: digest_emails/periodic-digest.png
48+
:align: center
49+
:alt: Customize default Digest Email settings and custom KPIs.
50+
51+
.. _digest-emails/custom-emails:
52+
53+
Custom digest emails
54+
====================
55+
56+
To do so, click on **-> Configure Digest Emails** and then **Create**.
57+
58+
From there, give your Digest Email a title, specify periodicity, and choose your desired KPIs and
59+
recipients fields as needed.
60+
61+
After you click **Save**, your new custom Digest Email is available as a selection in the **General
62+
Settings** dropdown menu.
63+
64+
.. _digest-emails/custom-kpi:
65+
66+
Custom KPIs with Studio
67+
-----------------------
68+
69+
For either *Your Odoo Periodic Digest* or your own custom Digest Email, you can add your own KPIs
70+
by using Odoo Studio.
71+
72+
To begin, click the **Toggle Studio** icon or click the **Recipients** tab and then the ellipses
73+
:menuselection:`… icon --> Add Custom Field` to edit the template or add additional fields.
74+
75+
In order to create additional fields, you must create two fields on the digest object:
76+
77+
#. create a boolean field called `kpi_myfield` and display it in the KPIs tab
78+
#. create a computed field called `kpi_myfield_value` that computes your customized KPI
79+
#. select your KPI(s) in the KPIs tab.
80+
81+
Computed values reference table
82+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
83+
84+
+-----------------------+-----------------------------------------+
85+
| LABEL | VALUE |
86+
+-----------------------+-----------------------------------------+
87+
| Connected Users | kpi_res_users_connected_value |
88+
+-----------------------+-----------------------------------------+
89+
| Messages Sent | kpi_mail_message_total_value |
90+
+-----------------------+-----------------------------------------+
91+
| New Leads | kpi_mail_message_total_value |
92+
+-----------------------+-----------------------------------------+
93+
| Opportunities Won | kpi_crm_opportunities_won_value |
94+
+-----------------------+-----------------------------------------+
95+
| Open Tasks | kpi_project_task_opened_value |
96+
+-----------------------+-----------------------------------------+
97+
| Tickets Closed | kpi_helpdesk_tickets_closed_value |
98+
+-----------------------+-----------------------------------------+
99+
| % of Happiness | kpi_livechat_rating_value |
100+
+-----------------------+-----------------------------------------+
101+
| Conversations handled | kpi_livechat_conversations_value |
102+
+-----------------------+-----------------------------------------+
103+
| Time to answer (sec) | kpi_livechat_response_value |
104+
+-----------------------+-----------------------------------------+
105+
| All Sales | kpi_all_sale_total_value |
106+
+-----------------------+-----------------------------------------+
107+
| eCommerce Sales | kpi_website_sale_total_value |
108+
+-----------------------+-----------------------------------------+
109+
| Revenue | kpi_account_total_revenue_value |
110+
+-----------------------+-----------------------------------------+
111+
| Bank & Cash Moves | kpi_account_bank_cash_value |
112+
+-----------------------+-----------------------------------------+
113+
| POS Sales | kpi_pos_total_value |
114+
+-----------------------+-----------------------------------------+
115+
| New Employees | kpi_hr_recruitment_new_colleagues_value |
116+
+-----------------------+-----------------------------------------+
36.2 KB
Loading
26 KB
Loading

0 commit comments

Comments
 (0)