[IMP] essentials: iap rewrite

closes odoo/documentation#8936

X-original-commit: cd49934d95
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
This commit is contained in:
tiku-odoo 2024-04-17 17:20:30 +00:00
parent 2e764af8be
commit 75b5e42a9b
8 changed files with 60 additions and 60 deletions

View File

@ -1,6 +1,6 @@
===================== ======================
In-app purchase (IAP) In-app purchases (IAP)
===================== ======================
.. |IAP| replace:: :abbr:`IAP (In-app purchases)` .. |IAP| replace:: :abbr:`IAP (In-app purchases)`
@ -22,7 +22,9 @@ the service in the app to activate it. However, each service requires its own pr
when they run out, users **must** :ref:`buy more <iap/buying_credits>` in order to keep using it. when they run out, users **must** :ref:`buy more <iap/buying_credits>` in order to keep using it.
.. note:: .. note::
Users with an Enterprise version of Odoo Online get free credits to test IAP features. Enterprise Odoo users with a valid subscription get free credits to test IAP features before
deciding to purchase more credits for the database. This includes demo/training databases,
educational databases, and one-app-free databases.
.. _in_app_purchase/portal: .. _in_app_purchase/portal:
@ -31,7 +33,7 @@ IAP services
|IAP| services are provided by Odoo, as well as third-parties, and have a wide range of uses. |IAP| services are provided by Odoo, as well as third-parties, and have a wide range of uses.
The following |IAP| services are provided by Odoo: The following |IAP| services are offered by Odoo:
- :guilabel:`Documents Digitization`: digitizes scanned or PDF vendor bills, expenses, and resumes - :guilabel:`Documents Digitization`: digitizes scanned or PDF vendor bills, expenses, and resumes
with OCR and AI. with OCR and AI.
@ -40,9 +42,12 @@ The following |IAP| services are provided by Odoo:
- :guilabel:`Lead Generation`: generates leads based on a set of criteria, and converts web visitors - :guilabel:`Lead Generation`: generates leads based on a set of criteria, and converts web visitors
into quality leads and opportunities. into quality leads and opportunities.
- :guilabel:`Snailmail`: sends customer invoices and follow-up reports by post, worldwide. - :guilabel:`Snailmail`: sends customer invoices and follow-up reports by post, worldwide.
- :guilabel:`Signer identification with itsme®`: ask document signatories in Odoo *Sign* to provide
their identity using the *itsme®* identity platform, which is available in Belgium and the
Netherlands.
For more information on every service currently available, visit the `Odoo IAP Catalog For more information on every service currently available (offered from developers other than Odoo),
<https://iap.odoo.com/iap/all-in-app-services>`_. visit the `Odoo IAP Catalog <https://iap.odoo.com/iap/all-in-app-services>`_.
Use IAP services Use IAP services
---------------- ----------------
@ -53,7 +58,7 @@ settings. To use a service, simply interact with it wherever it appears in the d
.. example:: .. example::
The following flow focuses on the *SMS* |IAP| service being used from a contact's record. The following flow focuses on the *SMS* |IAP| service being used from a contact's record.
This can be done by clicking the :guilabel:`📱 (phone) SMS` icon within the database. This can be done by clicking the :guilabel:`📱 SMS` icon within the database.
.. image:: in_app_purchase/sms-icon.png .. image:: in_app_purchase/sms-icon.png
:align: center :align: center
@ -61,16 +66,17 @@ settings. To use a service, simply interact with it wherever it appears in the d
One way to utilize the *SMS* |IAP| service with Odoo is showcased in the following steps: One way to utilize the *SMS* |IAP| service with Odoo is showcased in the following steps:
#. Navigate to the :menuselection:`Contacts application`, and click on a contact with a mobile First, navigate to the :menuselection:`Contacts application`, and click on a contact with a
phone number entered in either the :guilabel:`Phone` or :guilabel:`Mobile` field of the mobile phone number entered in either the :guilabel:`Phone` or :guilabel:`Mobile` field of the
contact form. contact form.
#. Hover the mouse over the :guilabel:`Phone` or :guilabel:`Mobile` field, and a :guilabel:`📱
(phone) SMS` icon appears to the right. Next, find the :guilabel:`📱 SMS` icon that appears to the right of the :guilabel:`Phone` or
#. Click the :guilabel:`📱 (phone) SMS` icon, and a :guilabel:`Send SMS Text Message` pop-up :guilabel:`Mobile` fields. Click the :guilabel:`📱 SMS` icon, and a :guilabel:`Send SMS Text
window appears. Message` pop-up window appears.
#. Type a message in the :guilabel:`Message` field of the :guilabel:`Send SMS Text Message`
pop-up window. Then, click the :guilabel:`Send SMS` button. Odoo then sends the message, via Type a message in the :guilabel:`Message` field of the pop-up window. Then, click the
SMS, to the contact, and logs what was sent in the *chatter* of the contact's form. :guilabel:`Send SMS` button. Odoo then sends the message, via SMS, to the contact, and logs what
was sent in the *chatter* of the contact's form.
Upon sending the SMS message, the prepaid credits for the *SMS* |IAP| service are automatically Upon sending the SMS message, the prepaid credits for the *SMS* |IAP| service are automatically
deducted from the existing credits. If there are not enough credits to send the message, Odoo deducted from the existing credits. If there are not enough credits to send the message, Odoo
@ -80,10 +86,10 @@ settings. To use a service, simply interact with it wherever it appears in the d
For more information on how to use various |IAP| services, and for more in-depth instructions For more information on how to use various |IAP| services, and for more in-depth instructions
related to SMS functionality in Odoo, review the documentation below: related to SMS functionality in Odoo, review the documentation below:
- :doc:`Lead mining </applications/sales/crm/acquire_leads/lead_mining>` - :doc:`Lead mining <../sales/crm/acquire_leads/lead_mining>`
- :doc:`Enrich your contacts base with Partner Autocomplete - :doc:`Enrich your contacts base with Partner Autocomplete
</applications/sales/crm/optimize/partner_autocomplete>` <../sales/crm/optimize/partner_autocomplete>`
- :doc:`SMS essentials </applications/marketing/sms_marketing/essentials/sms_essentials>` - :doc:`SMS essentials <../marketing/sms_marketing/essentials/sms_essentials>`
.. _in_app_purchase/credits: .. _in_app_purchase/credits:
@ -113,7 +119,7 @@ Credits are purchased in *Packs* from the `Odoo IAP Catalog
The number of credits consumed depends on the length of the SMS and the country of destination. The number of credits consumed depends on the length of the SMS and the country of destination.
For more information, refer to the :doc:`SMS Pricing and FAQ For more information, refer to the :doc:`SMS Pricing and FAQ
</applications/marketing/sms_marketing/pricing/pricing_and_faq>` documentation. <../marketing/sms_marketing/pricing/pricing_and_faq>` documentation.
.. _iap/buying_credits: .. _iap/buying_credits:
@ -124,9 +130,10 @@ If there are not enough credits to perform a task, the database automatically pr
of more credits. of more credits.
Users can check the current balance of credits for each service, and manually purchase more credits, Users can check the current balance of credits for each service, and manually purchase more credits,
by navigating to the :menuselection:`Settings app --> Search IAP --> View My Services`. by navigating to the :menuselection:`Settings app --> Contacts section`, and beneath the
:guilabel:`Odoo IAP` setting, click :guilabel:`View My Services`.
Doing so reveals an :guilabel:`IAP Account` page, listing the various |IAP| services in the Doing so reveals an :guilabel:`IAP Service` page, listing the various |IAP| services in the
database. From here, click an |IAP| service to open its :guilabel:`Account Information` page, where database. From here, click an |IAP| service to open its :guilabel:`Account Information` page, where
additional credits can be purchased. additional credits can be purchased.
@ -135,32 +142,29 @@ Manually buy credits
To manually buy credits in Odoo, follow these steps: To manually buy credits in Odoo, follow these steps:
#. Go to the :menuselection:`Settings application`. First, go to the :menuselection:`Settings application` and type `IAP` in the :guilabel:`Search...`
#. Type `IAP` in the search bar. bar. Alternatively users can scroll down to the :guilabel:`Contacts` section. Under the
#. Click :guilabel:`View My Services`. :guilabel:`Contacts` section, where it says :guilabel:`Odoo IAP`, click :guilabel:`View My
Services`.
.. image:: in_app_purchase/view-services.png .. image:: in_app_purchase/view-services.png
:align: center :align: center
:alt: The Settings app showing the Odoo IAP heading and View My Services button. :alt: The Settings app showing the Odoo IAP heading and View My Services button.
#. Doing so reveals an :guilabel:`IAP Account` page, listing the various |IAP| services in the Doing so reveals an :guilabel:`IAP Account` page, listing the various |IAP| services in the
database. From here, click an |IAP| service to open its :guilabel:`Account Information` page, database. From here, click an |IAP| service to open its :guilabel:`Account Information` page, where
where additional credits can be purchased. additional credits can be purchased.
#. On the :guilabel:`Account Information` page, click the :guilabel:`Buy Credit` button.
.. image:: in_app_purchase/account-info.png On the :guilabel:`Account Information` page, click the :guilabel:`Buy Credit` button. Doing so loads
:align: center a :guilabel:`Buy Credits for (IAP Account)` page in a new tab. From here, click :guilabel:`Buy` on
:alt: The Account Information page for an IAP service showing the Buy Credit button. the desired pack of credits. Then, follow the prompts to enter payment details, and confirm the
order.
#. Doing so loads a :guilabel:`Buy Credits for (IAP Account)` page in a new tab. From here, click .. image:: in_app_purchase/buy-pack.png
:guilabel:`Buy` on the desired pack of credits. Then, follow the prompts to enter payment :align: center
details, and confirm the order. :alt: The SMS service page on IAP.Odoo.com with four packs of credits available for purchase.
.. image:: in_app_purchase/buy-pack.png Once the transaction is complete, the credits are available for use in the database.
:align: center
:alt: The SMS service page on IAP.Odoo.com with four packs of credits available for purchase.
#. Once the transaction is complete, the credits are available for use in the database.
.. _in_app_purchase/low-credits: .. _in_app_purchase/low-credits:
@ -170,23 +174,19 @@ Low-credit notification
It is possible to be notified when credits are low, in order to avoid running out of credits, while It is possible to be notified when credits are low, in order to avoid running out of credits, while
using an |IAP| service. To do that, follow this process: using an |IAP| service. To do that, follow this process:
#. Go to the :menuselection:`Settings application`. Go to the :menuselection:`Settings application`, and type `IAP` in the :guilabel:`Search...` bar.
#. Type `IAP` in the search bar. Under the :guilabel:`Contacts` section, where it says :guilabel:`Odoo IAP`, click :guilabel:`View My
#. Click :guilabel:`View My Services`. Services`.
#. The available |IAP| accounts appear in a list view on the :guilabel:`IAP Account` page. From
here, click on the desired |IAP| account to view that service's :guilabel:`Account Information`
page.
#. On the :guilabel:`Account Information` page, tick the :guilabel:`Warn Me` box. Doing so reveals
two fields on the form: :guilabel:`Threshold` and :guilabel:`Warning Email`.
.. image:: in_app_purchase/low-credits.png The available |IAP| accounts appear in a list view on the :guilabel:`IAP Account` page. From here,
:align: center click on the desired |IAP| account to view that service's :guilabel:`Account Information` page.
:alt: Odoo will send an email alert when credits for this service fall below the threshold.
#. In the :guilabel:`Threshold` field, enter an amount of credits Odoo should use as the minimum On the :guilabel:`Account Information` page, tick the :guilabel:`Warn Me` checkbox. Doing so reveals
threshold for this service. two fields on the form: :guilabel:`Threshold` and :guilabel:`Warning Email`.
#. In the :guilabel:`Warning Email` field, enter the email address that should receive the
notification. In the :guilabel:`Threshold` field, enter an amount of credits Odoo should use as the
minimum threshold for this service. In the :guilabel:`Warning Email` field, enter the email address
that receives the notification.
Odoo sends a low-credit alert to the :guilabel:`Warning Email` when the balance of credits falls Odoo sends a low-credit alert to the :guilabel:`Warning Email` when the balance of credits falls
below the amount listed as the :guilabel:`Threshold`. below the amount listed as the :guilabel:`Threshold`.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.7 KiB

After

Width:  |  Height:  |  Size: 8.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.4 KiB

After

Width:  |  Height:  |  Size: 3.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.1 KiB

After

Width:  |  Height:  |  Size: 9.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 6.9 KiB