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