Skip to content

Commit e47365d

Browse files
StraubCreativeStraubCreative
committed
[ADD] general/digest_emails: add new digest emails docs
1 parent 69f198e commit e47365d

File tree

6 files changed

+115
-6
lines changed

6 files changed

+115
-6
lines changed

‎content/applications/general.rst‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@ Miscellaneous
44

55
.. toctree::
66

7-
general/users
8-
general/auth
97
general/apps_modules
10-
general/export_import_data
11-
general/payment_acquirers
12-
general/voip
8+
general/auth
139
general/calendars
14-
general/in_app_purchase
1510
general/developer_mode
11+
general/digest_emails
12+
general/export_import_data
13+
general/in_app_purchase
14+
general/payment_acquirers
15+
general/users
16+
general/voip

‎content/applications/general/digest_email_settings.png‎

19.3 KB
Loading

‎content/applications/general/digest_emails.rst‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
:show-content:
2+
3+
============================
4+
Digest Emails
5+
============================
6+
7+
.. toctree::
8+
:titlesonly:
9+
10+
digest_emails/customize_periodic_digest
11+
digest_emails/create_digest_email
12+
13+
**Digest Emails** are periodic snapshots sent to your organization via email that include high-level information about how your business is performing.
14+
15+
Navigate to Digest Emails by going to :menuselection:`Settings --> General Settings --> Statistics`, then activate the **Digest Emails** feature and click on save.
16+
17+
.. image:: digest_email_settings.png
18+
:align: center
19+
:alt: Digest Emails settings are controlled under the Statistics section under Settings > General Settings.
20+
21+
You can control a variety of settings for your Digest Emails, such as:
22+
23+
- which KPIs are shared in the Digest
24+
- how often Digest Emails are sent
25+
- who in your organization receives Digest Emails
26+
- creating custom Digest Email templates
27+
- adding additional KPIs (Studio required)
28+
29+
.. note::
30+
By default, Digest Email is *enabled*, and *Your Odoo Periodic Digest* serves as the primary template, which includes all KPI measurements across your Odoo database and is sent daily to administrators.
31+
32+
.. seealso::
33+
- :doc:`digest_emails/customize_periodic_digest`
34+
- :doc:`digest_emails/create_digest_email`

‎content/applications/general/digest_emails/create_digest_email.rst‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
=============================
2+
Create your own digest emails
3+
=============================
4+
To create your own Digest Email, navigate to your **Settings** App and proceed to :menuselection:`General Settings --> Statistics --> Digest Settings`. Click **--> Configure Digest Emails** and then click **Create**.
5+
6+
From there, give your Digest Email a title, specify periodicity, and choose your desired KPIs and recipients fields as needed. After you click **Save**, your new custom Digest Email will be available from the list under **Settings / Digest Emails** and in the dropdown menu on the General Settings screen.
7+
8+
Add custom KPIs with Odoo Studio
9+
================================
10+
For either *Your Odoo Periodic Digest* or your own custom Digest Email, you can add your own KPIs by using Odoo Studio.
11+
12+
To begin, click the **Toggle Studio** icon or click the **Recipients** tab and then the ellipses :menuselection:`… icon --> Add Custom Field` to edit the template or add additional fields.
13+
14+
In order to create additional fields, you must create 2 fields on the digest object:
15+
16+
#. first, create a boolean field called `kpi_myfield` and display it in the KPIs tab;
17+
#. then create a computed field called `kpi_myfield_value` that will compute your customized KPI;
18+
#. finally, select your KPI(s) in the KPIs tab.
19+
20+
Computed values reference table
21+
-------------------------------
22+
+-----------------------+-----------------------------------------+
23+
| LABEL | VALUE |
24+
+-----------------------+-----------------------------------------+
25+
| Connected Users | kpi_res_users_connected_value |
26+
+-----------------------+-----------------------------------------+
27+
| Messages Sent | kpi_mail_message_total_value |
28+
+-----------------------+-----------------------------------------+
29+
| New Leads | kpi_mail_message_total_value |
30+
+-----------------------+-----------------------------------------+
31+
| Opportunities Won | kpi_crm_opportunities_won_value |
32+
+-----------------------+-----------------------------------------+
33+
| Open Tasks | kpi_project_task_opened_value |
34+
+-----------------------+-----------------------------------------+
35+
| Tickets Closed | kpi_helpdesk_tickets_closed_value |
36+
+-----------------------+-----------------------------------------+
37+
| % of Happiness | kpi_livechat_rating_value |
38+
+-----------------------+-----------------------------------------+
39+
| Conversations handled | kpi_livechat_conversations_value |
40+
+-----------------------+-----------------------------------------+
41+
| Time to answer (sec) | kpi_livechat_response_value |
42+
+-----------------------+-----------------------------------------+
43+
| All Sales | kpi_all_sale_total_value |
44+
+-----------------------+-----------------------------------------+
45+
| eCommerce Sales | kpi_website_sale_total_value |
46+
+-----------------------+-----------------------------------------+
47+
| Revenue | kpi_account_total_revenue_value |
48+
+-----------------------+-----------------------------------------+
49+
| Bank & Cash Moves | kpi_account_bank_cash_value |
50+
+-----------------------+-----------------------------------------+
51+
| POS Sales | kpi_pos_total_value |
52+
+-----------------------+-----------------------------------------+
53+
| New Employees | kpi_hr_recruitment_new_colleagues_value |
54+
+-----------------------+-----------------------------------------+

‎content/applications/general/digest_emails/customize_periodic_digest.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
=====================================
2+
Customize *Your Odoo Periodic Digest*
3+
=====================================
4+
5+
To cuzomize the standard *Your Odoo Periodic Digest* email, find the **Digest Email** heading under the **Statistics** section in :menuselection:`Settings --> General Settings`. Then click the **[-->]** icon next to the dropdown selection.
6+
7+
A popup window will appear and present a edit a variety of settings, which include:
8+
9+
- **Digest Title** - what you would like your Digest Email to be called
10+
- **Periodicity** - control the regimen in how often Digest Emails are sent
11+
- **KPIs** - check/uncheck each calculated KPI that will appear in Digest Emails
12+
- **Recipients** - add/remove users who receive your Digest Emails
13+
- **Custom** - add your own KPIs (Studio required)
14+
15+
.. image:: media/periodic_digest_window.png
16+
:align: center
17+
:alt: Customize the default email settings and KPIs of *Your Odoo Periodic Digest* in General Settings.
18+
19+
.. seealso::
20+
- :doc:`create_digest_email`

‎content/applications/general/digest_emails/media/periodic_digest_window.png‎

79.7 KB
Loading

0 commit comments

Comments
 (0)