[ADD] marketing automation: added 'getting started' section and docs to round out documentation

closes odoo/documentation#3158 X-original-commit: 4f6b03dc5b Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-08-02 17:21:19 +00:00
parent 5dcf9f7e86
commit ec61b2eeb0
28 changed files with 370 additions and 50 deletions
@@ -1,76 +1,80 @@
 =====================
-Understanding Metrics
+Understanding metrics
 =====================
-Metrics are values that help you measure progress and can be a powerful way of linking your
-employees to goals.

+Metrics are detailed statistics that measure the progress (and success) of marketing campaigns.
+When creating marketing activities in a workflow, Odoo will visually display various metrics
+related to the campaign with graphs and data.

-| When you create a workflow in Odoo, its visual content already shows metrics in a graph form and
-  in numbers.
-| Let’s consider the example below:
+Consider the following example:

-
-.. image:: understanding_metrics/metrics1.png
+.. image:: understanding_metrics/commercial-prospection-campaign-example.png
   :align: center
-   :alt: Metrics in Odoo Marketing Automation
+   :alt: An example of a marketing automation campaign in Odoo.

+In this case, the :guilabel:`Target` of this campaign is set to :guilabel:`Lead/Opportunity` and
+was narrowed down to only focus on the Leads (or Opportunities) whose :guilabel:`Tag Name` contain
+a value of `product` and they *also* have an email address set up in the database.

-| The *Target* - business object - is *Lead/Opportunity* and was narrowed down to the ones whose
-  *Tag Name* contain the description “Product”, and have an email address set.
-| A total number of 20 records match the criteria.
+Beneath the filter nodes, Odoo will display how many records in the database fall into the
+previously-specified criteria filter. In this example, there are 18 records in the database that
+match the criteria.

-
-.. image:: understanding_metrics/metrics2.png
+.. image:: understanding_metrics/marketing-automation-lead-filters.png
   :align: center
-   :alt: Metrics in Odoo Marketing Automation
-
-
-Out of those 20 records, 25 have become participants, in other words, they have matched the criteria.
-
-
-.. image:: understanding_metrics/metrics3.png
-   :align: center
-   :alt: Metrics in Odoo Marketing Automation
-
-
-Every time the system runs, updating numbers and triggering actions, it will look at the *Target*
-model and check if new records have been added or modified, keeping the flow up-to-date.
+   :alt: Lead generation filters used to refine records on marketing automation campaigns in Odoo.

+At the top of the marketing automation form, there are a series of smart buttons. The
+:guilabel:`Participations` smart button in this example indicates that, out of those 18 records, 25
+have become participants. In other words, they have matched the criteria, and have already
+interacted with the campaign in one way or another.

 .. note::
-   The filter here is applied to *all* activities. Leads that lose the tag in the meantime will be
-   excluded from later activities.
+   :guilabel:`Records` represent a real-time number. Therefore, while the workflow is running,
+   changes in opportunity records (deletions, additions, adjustments) may occur. This means there
+   will be real-time updates to the number of :guilabel:`Records`, but such updates do *not* change
+   the number of :guilabel:`Participants`, as the metric *will not* exclude opportunities that have
+   already been set as :guilabel:`Participants` before - Odoo will just add new ones. That's why
+   the number of :guilabel:`Records` can be different from the number of :guilabel:`Participants`
+   from time to time.

+.. image:: understanding_metrics/campaign-records-vs-participants.png
+   :align: center
+   :alt: Difference between real-time record count and total participants on a markeing campaign.

-*Records* is a real-time number, therefore while the workflow is running, changes in opportunity
-records can be made - delete, add, adjustment - updating the number of records, but not changing the
-number of participants, as the metric *will not* exclude opportunities that have been set as
-participants before. It will just add new ones. For this reason, the number of *Records* can be
-different from the number of *Participants*.
+Whenever the system runs, updating numbers and triggering actions, it will look at the
+:guilabel:`Target` model, and check if new :guilabel:`Records` have been added (or modified),
+which always keeps the flow up-to-date.

+.. note::
+   The filter here is applied to *all* activities. Leads that lose that specific :guilabel:`Tag`
+   in the meantime will be excluded from later activities.

 .. tip::
-   | You can also have filters applied to activities individually, under *Domain*. A useful feature
-     to specify an individual filter that will only be performed if the records satisfied both
-     filters, the activity and its domain one.
-   | Example: for an activity sending an SMS, you could make sure a phone number is set to
-     avoid triggering a SMS that would never be sent and crash.
+   Filters can also be applied to individual activities, in the :guilabel:`Domain` section of the
+   activity pop-up form. Use this feature to specify an individual filter that will only be
+   performed if the records satisfy *both* filter criteria - the activity filter and its specific
+   domain filter.

-   .. image:: understanding_metrics/metrics4.png
+   (*Example*: when configuring an SMS activity, make sure a certain phone number is set,
+   in order to avoid triggering a SMS that would never be sent.)
+
+   .. image:: understanding_metrics/individual-filter-to-activity.png
      :align: center
-      :alt: Metrics in Odoo Marketing Automation
+      :alt: A relevant targeting filter that applies to a type of individual activity.

-| *Success* is the number of times the searching for participants - that match the filter(s) of that
-  activity - was performed successfully in relation to the total number of participants.
-| If a participant does not match the conditions, it will be added to *Rejected*.
+:guilabel:`Success` represents the number of times the searching for participants - who match the
+criteria filter(s) of that activity - was performed successfully, in relation to the total number
+of participants. If a participant does *not* match the conditions, it will be added to
+:guilabel:`Rejected`.

-.. image:: understanding_metrics/metrics5.png
+.. image:: understanding_metrics/participant-matching-success-vs-rejected.png
   :align: center
-   :alt: Metrics in Odoo Marketing Automation
+   :alt: Overview showing participants who do or do not match filtering criteria on an activity.

-Hovering over the graph, you can see the number of successful and rejected participants, per day,
-for the last 15 days.
+Hovering over the graph, Odoo displays the number of successful and rejected participants, per day,
+over the last 15 days.

 .. note::
-   Every time a new record is added to the *Target* model, it will be automatically added to the
-   workflow, and, it will start the workflow from the beginning (parent action).
+   Whenever a new record is added to the :guilabel:`Target` model, it will automatically be added
+   to the workflow, and it will start the workflow from the beginning (:guilabel:`Parent Action`).