odoo-forge-bundle 0.1.0

package/payload/skills/odoo18-docs/references/docs/applications/general/companies/digest_emails.md

@@ -0,0 +1,259 @@
+---
+title: "Digest emails"
+source_url: "https://docs.odoo.sbggai.top/applications/general/companies/digest_emails.html"
+---
+
+=============
+# 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 :menuselection:`Settings app --> Statistics
+section`, activate the :guilabel:`Digest Emails` feature, and click :guilabel:`Save`.
+
+.. image:: digest_emails/digest-email-settings.png
+   :align: center
+   :alt: Digest Emails section inside General Settings.
+
+A variety of settings can be configured for digest emails, such as:
+
+- Deciding which :abbr:`KPIs (key performance indicators)` 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 :abbr:`KPIs (key performance indicators)` (*Studio* app required)
+
+> **note**:
+>    By default, the :guilabel:`Digest Email` feature is enabled. :guilabel:`Your Odoo Periodic
+   Digest` serves as the primary template, which includes all :abbr:`KPI (key performance
+   indicator)` 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 :menuselection:`Settings --> Statistics section`.
+   Then, deactivate the :guilabel:`Digest Emails` feature, by un-ticking the checkbox, and clicking
+   :guilabel:`Save`. See the section on :ref:`digest-emails/deactivate`.
+
+.. _digest-emails/customize-digest:
+
+# Customize default digest email
+
+To customize the default digest email (*Your Odoo Periodic Digest*), go to :menuselection:`Settings
+app --> Statistics section --> Digest Email field`. Then, select :guilabel:`Your Odoo Periodic
+Digest`, and click on the :guilabel:`↗️ (External link)` icon, next to the drop-down menu selection.
+
+A pop-up window appears, and presents a variety of editable settings, which include:
+
+- :guilabel:`Digest Name`: the name of the digest email.
+- :guilabel:`Periodicity`: control how often digest emails are sent (:guilabel:`Daily`,
+  :guilabel:`Weekly`, :guilabel:`Monthly`, or :guilabel:`Quarterly`).
+- :guilabel:`Next Send Date`: the date on which the digest email will be sent again.
+- :guilabel:`KPIs` tab: check/uncheck each calculated :abbr:`KPI (key performance indicator)` that
+  appears in digest emails. A ticked box indicates an active :abbr:`KPI (key performance indicator)`
+  in the digest email. See the section on :ref:`digest-emails/kpis`.
+- :guilabel:`Recipients` tab: add/remove users who receive the digest emails. See the section on
+  :ref:`digest-emails/recipients`.
+
+> **note**:
+>    The :abbr:`KPIs (key performance indicators)` can be customized using Odoo *Studio*. Additional
+   costs to the database subscription are incurred should *Studio* need to be installed. See this
+   section on :ref:`digest-emails/custom-kpi`.
+
+.. image:: digest_emails/periodic-digest.png
+   :align: center
+   :alt: Customize default Digest Email settings and custom KPIs.
+
+.. _digest-emails/deactivate:
+
+# Deactivate digest email
+
+To manually deactivate an individual digest email, first navigate to :menuselection:`Settings app
+--> Statistics section`, and click :guilabel:`Configure Digest Emails`. Then, select the desired
+digest email from the list that should be deactivated.
+
+Next, click :guilabel:`DEACTIVATE FOR EVERYONE` to deactivate the digest email for everyone, or
+:guilabel:`UNSUBSCRIBE ME` to remove the logged in user from the mailing list. These buttons are
+located in the top menu, just above the :guilabel:`Digest Name`.
+
+# Manually send digest email
+
+To manually send a digest email, first navigate to :menuselection:`Settings app --> Statistics
+section`, and click :guilabel:`Configure Digest Emails`. Then, select the desired digest email, and
+click :guilabel:`SEND NOW`. This button is located in the top menu, just above the :guilabel:`Digest
+Name`.
+
+.. _digest-emails/kpis:
+
+# KPIs
+
+Pre-configured :abbr:`KPIs (key performance indicators)` can be added to the digest email from the
+:guilabel:`KPIs` tab of the digest email template form.
+
+First, navigate to :menuselection:`Settings app --> Statistics section`, and click
+:guilabel:`Configure Digest Emails`.
+
+Then, select the desired digest email, and open the :guilabel:`KPIs` tab.
+
+To add a :abbr:`KPI (key performance indicator)` to the digest email, tick the checkbox next to the
+desired :abbr:`KPI (key performance indicator)`. After all :abbr:`KPIs (key performance indicators)`
+are added (or deselected), click :guilabel:`Save`.
+
+The following :abbr:`KPIs (key performance indicators)` are available in the :guilabel:`KPIs` tab on
+a digest email template form out-of-box in Odoo:
+
+.. image:: digest_emails/oob-kpis.png
+   :align: right
+   :alt: KPIs listed in the out-of-box digest email.
+
+:guilabel:`General`
+   - :guilabel:`Connected Users`
+   - :guilabel:`Messages`
+
+:guilabel:`Project`
+   - :guilabel:`Open Tasks`
+
+:guilabel:`Recruitment`
+   - :guilabel:`Employees`
+
+:guilabel:`CRM`
+   - :guilabel:`New Leads/Opportunities`
+   - :guilabel:`Opportunities Won`
+
+:guilabel:`Sales`
+   - :guilabel:`All Sales`
+   - :guilabel:`eCommerce Sales`
+
+:guilabel:`Point of Sale`
+   - :guilabel:`POS Sales`
+
+:guilabel:`Live Chat`
+   - :guilabel:`% of Happiness`
+   - :guilabel:`Conversations handled`
+   - :guilabel:`Time to answer (sec)`
+
+:guilabel:`Helpdesk`
+   - :guilabel:`Tickets Closed`
+
+:guilabel:`Invoicing`
+   - :guilabel:`Revenue`
+   - :guilabel:`Banks and Cash Moves`
+
+.. _digest-emails/recipients:
+
+# Recipients
+
+Digest email recipients are added from the :guilabel:`Recipients` tab of the digest email template
+form.
+
+To add a recipient, navigate to :menuselection:`Settings app --> Statistics section`, and click
+:guilabel:`Configure Digest Emails`. Then, select the desired digest email, and open the
+:guilabel:`Recipients` tab.
+
+To add a recipient, click :guilabel:`Add a line`, and an :guilabel:`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 :guilabel:`Name` of the user(s), and click the
+:guilabel:`Select` button.
+
+To remove a user as a recipient, click the :guilabel:`❌ (remove)` icon to the far-right of the user
+listed in the :guilabel:`Recipients` tab.
+
+Click :guilabel:`Save` to implement the changes.
+
+.. _digest-emails/custom-emails:
+
+# Create digest emails
+
+To create a new digest email, navigate to :menuselection:`Settings app --> Statistics section`, and
+click :guilabel:`Configure Digest Emails`. Then, click :guilabel:`Create` to create a new digest
+email.
+
+A separate page, with a blank digest email template appears, and presents a variety of editable
+settings, including:
+
+- :guilabel:`Digest Name`: the name of the digest email.
+- :guilabel:`Periodicity`: control how often digest emails are sent (:guilabel:`Daily`,
+  :guilabel:`Weekly`, :guilabel:`Monthly`, or :guilabel:`Quarterly`).
+- :guilabel:`Next Send Date`: the date on which the digest email will be sent again.
+- :guilabel:`KPIs` tab: check/uncheck each calculated :abbr:`KPI (key performance indicator)` that
+  appears in digest emails. A ticked box indicates an active :abbr:`KPI (key performance indicator)`
+  in the digest email. See the section on :ref:`digest-emails/kpis`.
+- :guilabel:`Recipients` tab: add/remove users who receive the digest emails. See the section on
+  :ref:`digest-emails/recipients`.
+
+From there, give the digest email a :guilabel:`Digest Name`, specify :guilabel:`Periodicity`,
+choose the desired :abbr:`KPIs (key performance indicators)`, and add :guilabel:`Recipients`, as
+needed.
+
+After clicking :guilabel:`Save`, the new custom digest email is available as a selection in the
+:guilabel:`Digest Email` field, located in the :menuselection:`Settings app --> Statistics section`.
+
+.. _digest-emails/custom-kpi:
+
+# Custom KPIs with Odoo Studio
+
+The :abbr:`KPIs (key performance indicators)` on a digest email template form, in the
+:guilabel:`KPIs` tab, can be customized using Odoo *Studio*.
+
+> **warning**:
+>    Additional costs to the database subscription are incurred, should Odoo *Studio* need to be
+   installed.
+
+To begin, click the :guilabel:`🛠️ (tools)` icon in the top-right of the screen. This is the link to
+the Odoo *Studio* application.
+
+In order to create additional fields, create two fields on the digest object:
+
+#. Create a boolean field called `kpi_myfield`, and display it in the :guilabel:`KPIs` tab.
+#. Create a computed field called `kpi_myfield_value` that computes the customized :abbr:`KPI (key
+   performance indicator)`.
+#. Select the :abbr:`KPIs (key performance indicators)` in the :guilabel:`KPIs` tab.
+
+> **tip**:
+>    Here is the [source code
+   ](https://github.com/odoo/odoo/blob/15.0/addons/digest/models/digest.py) for the `digest.py`
+   file, which guides the programmer in the coding of the computed field.
+
+.. seealso::
+   Users can also click the :guilabel:`Recipients` tab, and then the vertical three-dot
+   :guilabel:`(kebab)` menu to edit this view. Either click :guilabel:`EDIT LIST VIEW` or
+   :guilabel:`EDIT FORM VIEW` to modify this tab.
+
+## 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`           |
++-----------------------+-------------------------------------------+
+| Tickets Closed        | `kpi_helpdesk_tickets_closed_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`         |
++-----------------------+-------------------------------------------+
+| Bank & Cash Moves     | `kpi_account_bank_cash_value`             |
++-----------------------+-------------------------------------------+
+| POS Sales             | `kpi_pos_total_value`                     |
++-----------------------+-------------------------------------------+
+| New Employees         | `kpi_hr_recruitment_new_colleagues_value` |
++-----------------------+-------------------------------------------+

package/payload/skills/odoo18-docs/references/docs/applications/general/companies/email_template.md

@@ -0,0 +1,288 @@
+---
+title: "Email templates"
+source_url: "https://docs.odoo.sbggai.top/applications/general/companies/email_template.html"
+---
+
+===============
+# Email templates
+
+Email templates are saved emails that are used repeatedly to send emails from the database. They
+allow users to send quality communications, without having to compose the same text repeatedly.
+
+Creating different templates that are tailored to specific situations lets users choose the right
+message for the right audience. This increases the quality of the message and the overall
+engagement rate with the customer.
+
+> **note**:
+>    Email templates in Odoo use QWeb or XML, which allows for editing emails in their final
+   rendering, making customizations more robust, without having to edit any code whatsoever. This
+   means that Odoo can use a Graphical User Interface (GUI) to edit emails, which edits the backend
+   code. When the received email is read by the end user's program, different formatting and
+   graphics will appear in the final form of it.
+
+Access email templates in :ref:`developer mode <developer-mode>` by navigating to
+:menuselection:`Settings app --> Technical menu --> Email --> Email Templates`.
+
+# Editing email templates
+
+The *powerbox* feature can be used when working with email templates. This feature provides the
+ability to directly edit the formatting and text in an email template, as well as the ability to add
+links, buttons, appointment options, or images.
+
+Additionally, the XML/HTML code of the email template can be edited directly, via the
+:guilabel:`</>` icon. Dynamic placeholders (referencing fields within Odoo) are also available for
+use in the email template.
+
+## Powerbox
+
+The *powerbox* feature is an enriched text editor with various formatting, layout, and text options.
+It can also be used to add XML/HTML features in an email template. The powerbox feature is activated
+by typing a forward slash `/` in the body of the email template.
+
+When a forward slash `/` is typed in the body of an email template, a drop-down menu appears with
+the following options:
+
+:guilabel:`Structure`
+
+- :guilabel:`Bulleted list`: Create a simple bulleted list.
+- :guilabel:`Numbered list`: Create a list with numbering.
+- :guilabel:`Checklist`: Track tasks with a checklist.
+- :guilabel:`Table`: Insert a table.
+- :guilabel:`Separator`: Insert a horizontal rule separator.
+- :guilabel:`Quote`: Add a blockquote section.
+- :guilabel:`Code`: Add a code section.
+- :guilabel:`2 columns`: Convert into two columns.
+- :guilabel:`3 columns`: Convert into three columns.
+- :guilabel:`4 columns`: Convert into four columns.
+
+:guilabel:`Format`
+
+- :guilabel:`Heading 1`: Big section heading.
+- :guilabel:`Heading 2`: Medium section heading.
+- :guilabel:`Heading 3`: Small section heading.
+- :guilabel:`Switch direction`: Switch the text's direction.
+- :guilabel:`Text`: Paragraph block.
+
+:guilabel:`Media`
+
+- :guilabel:`Image`: Insert an image.
+- :guilabel:`Article`: Link an article.
+
+:guilabel:`Navigation`
+
+- :guilabel:`Link`: Add a link.
+- :guilabel:`Button`: Add a button.
+- :guilabel:`Appointment`: Add a specific appointment.
+- :guilabel:`Calendar`: Schedule an appointment.
+
+:guilabel:`Widgets`
+
+- :guilabel:`3 Stars`: Insert a rating over three stars.
+- :guilabel:`5 Stars`: Insert a rating over five stars.
+
+:guilabel:`Basic Blocks`
+
+- :guilabel:`Signature`: Insert your signature.
+
+:guilabel:`Marketing Tools`
+
+- :guilabel:`Dynamic Placeholders`: Insert personalized content.
+
+> **tip**:
+>    To use any of these options, click on the desired feature from the powerbox drop-down menu. To
+   format existing text with a text-related option (e.g. :guilabel:`Heading 1`, :guilabel:`Switch
+   direction`, etc.), highlight the text, then type in the activator key (forward slash) `/`, and
+   select the desired option from the drop-down menu.
+
+   .. image:: email_template/powerbox-feature.png
+      :align: center
+      :alt: Powerbox feature in the email template.
+
+.. seealso::
+   :ref:`Using dynamic placeholders <email_template/dynamic-placeholders>`
+
+## XML/HTML code editor
+
+To access the XML/HTML editor for an email template, first enter :ref:`developer mode
+<developer-mode>`. Then, click the :guilabel:`</>` icon in the upper-right corner of the template,
+and proceed to edit the XML/HTML. To return to the standard text editor, click the :guilabel:`</>`
+icon again.
+
+.. image:: email_template/html-code-editor.png
+   :align: center
+   :alt: HTML editor in the email template.
+
+> **warning**:
+>    The XML/HTML editor should be accessed with caution as this is the backend code of the template.
+   Editing the code can cause the email template to break immediately or when upgrading the
+   database.
+
+.. _email_template/dynamic-placeholders:
+
+## Dynamic placeholders
+
+*Dynamic placeholders* reference certain fields within the Odoo database to produce unique data in
+the email template.
+
+.. example::
+   Many companies like to customize their emails with a personalized piece of customer information
+   to grab attention. This can be accomplished in Odoo by referencing a field within a model by
+   inserting a dynamic placeholder. For example, a customer's name can be referenced in the email
+   from the :guilabel:`Customer` field on the :guilabel:`Sales Order` model. The dynamic placeholder
+   for this field is: `{{ object.partner_id }}`.
+
+Dynamic placeholders are encoded to display fields from within the database. Dynamic placeholders
+can be used in the :guilabel:`Body` (:guilabel:`Content` Tab) of the email template. They can also
+be used in the fields present in the :guilabel:`Email Configuration` tab, the :guilabel:`Subject` of
+the email, and the :guilabel:`Language`.
+
+To use the dynamic placeholders in the :guilabel:`Body` of an email open the **powerbox** feature by
+typing in `/` into the body of the email template under the :guilabel:`Content` tab. Scroll to the
+bottom of the options list, to :guilabel:`Marketing Tools`. Next, select :guilabel:`Dynamic
+Placeholder`. Then select the dynamic placeholder from a list of available options and follow the
+prompts to configure it with the desired corresponding Odoo field. Each dynamic placeholder will
+vary in configuration.
+
+.. image:: email_template/dynamic-placeholders.png
+   :align: center
+   :alt: Using dynamic placeholders in an email template.
+
+> **note**:
+>    Each unique combination of :guilabel:`Fields`, :guilabel:`Sub-models` and :guilabel:`Sub-fields`
+   creates a different dynamic placeholder. Imagine it as a combination to the field that is being
+   created.
+
+   To search the available fields, simply type in the front-end name (on user-interface) of the
+   field in the search. This will find a result from all of the available fields for the model that
+   the email template is created for.
+
+> **warning**:
+>    Customizing email templates are out of the scope of Odoo Support.
+
+## Rich text editor
+
+A rich text editor toolbar can be accessed by highlighting text in the email template. This can be
+used to change the heading, font size/style, color, add a list type, or a link.
+
+.. image:: email_template/rich-text-editor.png
+   :align: center
+   :alt: Rich text editor in the email template.
+
+## Resetting email templates
+
+Should the email template not work because the code has been altered it can be reset to restore it
+back to the out-of-box default template. Simply click on the :guilabel:`Reset Template` button in
+the upper left-hand of the screen and the template will be reset.
+
+.. image:: email_template/reset.png
+   :align: center
+   :alt: Resetting the email template.
+
+## Default reply on email templates
+
+Under the :guilabel:`Email Configuration` tab on an email template, there is a :guilabel:`Reply To`
+field. In this field, add email addresses to which replies are redirected when sending emails en
+masse using this template.
+
+> **tip**:
+>    Add multiple email addresses by adding a comma `,` between the addresses or dynamic
+   placeholders.
+
+.. image:: email_template/reply-to-template-sales.png
+   :align: center
+   :alt: Reply-to field on template.
+
+The :guilabel:`Reply To` field is **only** used for mass mailing (sending emails in bulk). Bulk
+emails can be sent in almost every Odoo application that has a list view option.
+
+To send mass mails, while in :guilabel:`list` view, check the boxes next to the desired records
+where the emails are to be sent, click the :guilabel:`Action` button (represented by a :guilabel:`⚙️
+(gear)` icon), and select the desired email option from the :guilabel:`Action` drop-down menu. Email
+options can vary by the particular list view and application.
+
+If it is possible to send an email, a mail composer pop-up window appears, with values that can be
+defined and customized. This option will be available on the :guilabel:`Action` button on pages
+where emails can be sent in bulk---for example, on the :guilabel:`Customers` page of the CRM app.
+This action occurs throughout the Odoo database.
+
+.. image:: email_template/composer-mass-mailing.png
+   :align: center
+   :alt: Email composer in mass mailing mode with reply-to highlighted.
+
+# Transactional emails and corresponding URLs
+
+In Odoo, multiple events can trigger the sending of automated emails. These emails are known as
+*transactional emails*, and sometimes contain links redirecting to the Odoo database.
+
+By default, links generated by the database use the dynamic `web.base.url` key defined in the system
+parameters. For more information about this, see :ref:`system parameters
+<domain-name/web-base-url>`.
+
+If the *Website* application is not installed, the `web.base.url` key will always be the default
+parameter used to generate all the links.
+
+> **important**:
+>    The `web.base.url` key can only have a single value, meaning that, in a multi-website or
+   multi-company database environment, even if there is a specific domain name for each website, the
+   links generated to share a document (or the links within a transactional email) may remain the
+   same, regardless of which website/company is related to the sending of the email/document.
+
+   .. example::
+      If the :guilabel:`Value` of the :guilabel:`web.base.url` system parameter is equal to
+      `https://www.mycompany.com` and there are two separate companies in Odoo with different
+      website URLs: `https://www.mycompany2.com` and `https://www.mycompany1.com`, the links created
+      by Odoo to share a document, or send a transactional email, come from the domain:
+      `https://www.mycompany.com`, regardless of which company sends the document or email.
+
+   This is not always the case, as some Odoo applications (*eCommerce*, for example) have a link
+   established in the database with the *Website* application. In that case, if a specific domain is
+   defined for the website, the URL generated in the email template uses the domain defined on the
+   corresponding website of the company.
+
+   .. example::
+      When a customer makes a purchase on an Odoo *eCommerce* website, the order has an established
+      link with that website. As a result, the links in the confirmation email sent to the customer
+      use the domain name for that specific website.
+
+> **note**:
+>    A document shared using the *Documents* application will **always** use the `web.base.url` key,
+   as the document shared is not associated with any particular website. This means that the URL
+   will always be the same (the `web.base.url` key value), no matter what company it's shared from.
+   This is a known limitation.
+
+For more information about how to configure domains, check out the :doc:`domain name documentation
+</applications/websites/website/configuration/domain_names>`.
+
+## Updating translations within email templates
+
+In Odoo, email templates are automatically translated for all users in the database for all of the
+languages installed. Changing the translations shouldn't be necessary. However, if for a specific
+reason, some of the translations need to be changed, it can be done.
+
+> **warning**:
+>    Like any modification in the code, if translation changes are not done correctly (for example,
+   modifications leading to bad syntax), it can break the template, and as a result, the template
+   will appear blank.
+
+In order to edit translations, first enter :ref:`developer mode <developer-mode>`. Then, on the
+email template, click on the :guilabel:`Edit` button, and then click on the language button,
+represented by the initials of the language currently being used (e.g. :guilabel:`EN` for English).
+
+.. image:: email_template/edit-language-template.png
+   :align: center
+   :alt: Edit the language of a template.
+
+> **note**:
+>    If there aren't multiple languages installed and activated in the database, or if the user does
+   not have administration access rights, the language button will not appear.
+
+A pop-up window with the different languages installed on the database appears. From this pop-up,
+editing of translations is possible. When the desired changes have been made, click the
+:guilabel:`Save` button to save the changes.
+
+.. image:: email_template/translation-body.png
+  :align: center
+  :alt: Translation of the body of the Appointment Booked template.
+
+> **note**:
+>    When editing the translations, the default language set in the database appears in **bold**.