-
Notifications
You must be signed in to change notification settings - Fork 10.5k
[IMP] misc: IAP grammar updates and new image #7427
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,59 +1,192 @@ | ||
| ===================== | ||
| In-App Purchase (IAP) | ||
| In-app purchase (IAP) | ||
| ===================== | ||
|
|
||
| In-App Purchases (IAP) gives access to additional services through Odoo. For instance, it allows you | ||
| to send SMS Text Messages or to send Invoices by post directly from your database. | ||
| .. |IAP| replace:: :abbr:`IAP (In-app purchases)` | ||
|
|
||
| .. _iap/buying_credits: | ||
| In-app purchases (IAP) are optional services that enhance Odoo databases. Each service provides its | ||
| own specific features and functionality. A full list of services is available on the `Odoo IAP | ||
| Catalog <https://iap.odoo.com/iap/all-in-app-services>`_. | ||
|
|
||
| Buying Credits | ||
| ============== | ||
| .. image:: in_app_purchase/iap.png | ||
| :align: center | ||
| :alt: The IAP catalog with various services available on IAP.Odoo.com. | ||
|
|
||
MaxKeilOdoo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Each IAP Service relies on prepaid credits to work and has its own pricing. To consult your current | ||
| balance or to recharge your account, go to :menuselection:`Settings --> Odoo IAP --> View my | ||
| Services`. | ||
| .. example:: | ||
| The :guilabel:`SMS` service sends text messages to contacts directly from the database, and the | ||
| :guilabel:`Documents Digitization` service digitizes scanned or PDF vendor bills, expenses, and | ||
| resumes with optical character recognition (OCR) and artificial intelligence (AI). | ||
|
|
||
| .. image:: in_app_purchase/image1.png | ||
| :align: center | ||
| |IAP| services do **not** need to be configured or set up before use. Odoo users can simply click on | ||
| the service in the app to activate it. However, each service requires its own prepaid credits, and | ||
| when they run out, users **must** :ref:`buy more <iap/buying_credits>` in order to keep using it. | ||
|
|
||
| .. tip:: | ||
| If you are on Odoo Online and have the Enterprise version, you benefit from free credits to test our | ||
| IAP features. | ||
| .. note:: | ||
| Users with an Enterprise version of Odoo Online get free credits to test IAP features. | ||
|
|
||
| IAP accounts | ||
| .. _in_app_purchase/portal: | ||
|
|
||
| IAP services | ||
| ============ | ||
|
|
||
| Credits to use IAP services are stored on IAP accounts, which are specific to each service. | ||
| By default, IAP accounts are common to all companies, but can be restricted to specific | ||
| ones. Activate the :ref:`developer mode <developer-mode>`, then go to :menuselection:`Technical | ||
| Settings --> IAP Account`. | ||
| |IAP| services are provided by Odoo, as well as third-parties, and have a wide range of uses. | ||
|
|
||
| .. image:: in_app_purchase/image2.png | ||
| :align: center | ||
| The following |IAP| services are provided by Odoo: | ||
|
|
||
| .. tip:: | ||
| An IAP account can be disabled by appending `+disabled` to its token. | ||
| Reverting this change will re-enable the account. | ||
| - :guilabel:`Documents Digitization`: digitizes scanned or PDF vendor bills, expenses, and resumes | ||
| with OCR and AI. | ||
| - :guilabel:`Partner Autocomplete`: automatically populates contact records with corporate data. | ||
| - :guilabel:`SMS`: sends SMS text messages to contacts directly from the database. | ||
| - :guilabel:`Lead Generation`: generates leads based on a set of criteria, and converts web visitors | ||
| into quality leads and opportunities. | ||
| - :guilabel:`Snailmail`: sends customer invoices and follow-up reports by post, worldwide. | ||
|
|
||
| IAP Portal | ||
| ========== | ||
| For more information on every service currently available, visit the `Odoo IAP Catalog | ||
| <https://iap.odoo.com/iap/all-in-app-services>`_. | ||
|
|
||
| The IAP Portal is a platform regrouping your IAP Services. It is accessible from | ||
| :menuselection:`Settings app --> Odoo IAP --> View my Services`. From there, you can view your current | ||
| balance, recharge your credits and set a reminder when your balance falls below a threshold. | ||
| Use IAP services | ||
| ---------------- | ||
|
|
||
| .. image:: in_app_purchase/image3.png | ||
| :align: center | ||
| |IAP| services are automatically integrated with Odoo, and do **not** require users to configure any | ||
| settings. To use a service, simply interact with it wherever it appears in the database. | ||
|
|
||
| Get notified when credits are low | ||
| ================================= | ||
| .. example:: | ||
| The following flow focuses on the *SMS* |IAP| service being used from a contact's record. | ||
|
|
||
| To be notified when it’s time to recharge your credits, you can go to your IAP Portal through | ||
| :menuselection:`Settings app --> Odoo IAP --> View my Services`, unfold a service and check the | ||
| Receive threshold warning option. Then, you can provide a minimum amount of credits and email | ||
| addresses. Now, every time that the limit is reached, an automatic reminder will be sent by | ||
| email! | ||
| This can be done by clicking the :guilabel:`📱 (phone) SMS` icon within the database. | ||
|
|
||
| .. image:: in_app_purchase/image4.png | ||
| :align: center | ||
| .. image:: in_app_purchase/sms-icon.png | ||
| :align: center | ||
| :alt: The SMS icon on a typical contact information form located within an Odoo database. | ||
|
|
||
| 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 | ||
| phone number entered in either the :guilabel:`Phone` or :guilabel:`Mobile` field of the | ||
| contact form. | ||
| #. Hover the mouse over the :guilabel:`Phone` or :guilabel:`Mobile` field, and a :guilabel:`📱 | ||
| (phone) SMS` icon appears to the right. | ||
| #. Click the :guilabel:`📱 (phone) SMS` icon, and a :guilabel:`Send SMS Text 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 | ||
| SMS, to the contact, and logs what was sent in the *chatter* of the contact's form. | ||
|
|
||
MaxKeilOdoo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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 | ||
| prompts the user to purchase more. | ||
|
|
||
| .. seealso:: | ||
| 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: | ||
|
|
||
| - :doc:`Lead mining </applications/sales/crm/acquire_leads/lead_mining>` | ||
| - :doc:`Enrich your contacts base with Partner Autocomplete | ||
| </applications/sales/crm/optimize/partner_autocomplete>` | ||
| - :doc:`SMS essentials </applications/marketing/sms_marketing/essentials/sms_essentials>` | ||
|
|
||
| .. _in_app_purchase/credits: | ||
|
|
||
| IAP credits | ||
| =========== | ||
|
|
||
| Every time an |IAP| service is used, the prepaid credits for that service are spent. Odoo prompts | ||
| the purchase of more credits when there are not enough credits left to continue using a service. | ||
| Email alerts can also be set up for when :ref:`credits are low <in_app_purchase/low-credits>`. | ||
|
|
||
| Credits are purchased in *Packs* from the `Odoo IAP Catalog | ||
| <https://iap.odoo.com/iap/all-in-app-services>`_, and pricing is specific to each service. | ||
|
||
|
|
||
| .. example:: | ||
| The `SMS service <https://iap.odoo.com/iap/in-app-services/1>`_ has four packs available, in | ||
| denominations of: | ||
|
|
||
| - :guilabel:`Starter Pack`: 10 credits | ||
| - :guilabel:`Standard Pack`: 100 credits | ||
| - :guilabel:`Advanced Pack`: 500 credits | ||
| - :guilabel:`Expert Pack`: 1,000 credits | ||
|
|
||
| .. image:: in_app_purchase/packs.png | ||
| :align: center | ||
| :alt: Four different packs of credits for the SMS IAP service. | ||
|
|
||
| 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 | ||
| </applications/marketing/sms_marketing/pricing/pricing_and_faq>` documentation. | ||
|
|
||
| .. _iap/buying_credits: | ||
|
|
||
| Buy credits | ||
| ----------- | ||
|
|
||
| If there are not enough credits to perform a task, the database automatically prompts the purchase | ||
| of 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`. | ||
|
|
||
| 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, where | ||
| additional credits can be purchased. | ||
|
|
||
| Manually buy credits | ||
| ~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
MaxKeilOdoo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| To manually buy credits in Odoo, follow these steps: | ||
|
|
||
| #. Go to the :menuselection:`Settings application`. | ||
| #. Type `IAP` in the search bar. | ||
| #. Click :guilabel:`View My Services`. | ||
|
|
||
| .. image:: in_app_purchase/view-services.png | ||
| :align: center | ||
| :alt: The Settings app showing the Odoo IAP heading and View My Services button. | ||
MaxKeilOdoo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| #. 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, | ||
| where additional credits can be purchased. | ||
| #. On the :guilabel:`Account Information` page, click the :guilabel:`Buy Credit` button. | ||
|
|
||
| .. image:: in_app_purchase/account-info.png | ||
| :align: center | ||
| :alt: The Account Information page for an IAP service showing the Buy Credit button. | ||
|
|
||
| #. Doing so loads a :guilabel:`Buy Credits for (IAP Account)` page in a new tab. From here, click | ||
| :guilabel:`Buy` on the desired pack of credits. Then, follow the prompts to enter payment | ||
| details, and confirm the order. | ||
|
|
||
| .. image:: in_app_purchase/buy-pack.png | ||
| :align: center | ||
| :alt: The SMS service page on IAP.Odoo.com with four packs of credits available for purchase. | ||
MaxKeilOdoo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| #. Once the transaction is complete, the credits are available for use in the database. | ||
|
|
||
| .. _in_app_purchase/low-credits: | ||
|
|
||
| Low-credit notification | ||
| ~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| 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: | ||
|
|
||
| #. Go to the :menuselection:`Settings application`. | ||
| #. Type `IAP` in the search bar. | ||
| #. Click :guilabel:`View My 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 | ||
| :align: center | ||
| :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 | ||
| threshold for this service. | ||
| #. In the :guilabel:`Warning Email` field, enter the email address that should receive the | ||
| notification. | ||
|
|
||
| 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`. | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add abbreviations throughout the doc