From 7efbf490f62fb2f56f46461b0945d5fe335a3764 Mon Sep 17 00:00:00 2001 From: Elisabeth Dickinson Date: Mon, 31 May 2021 15:01:13 +0200 Subject: [PATCH 01/21] [FIX] odoo_theme: padding fix in sidenav --- extensions/odoo_theme/static/style.scss | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/extensions/odoo_theme/static/style.scss b/extensions/odoo_theme/static/style.scss index 944a7f28c..90d224eda 100644 --- a/extensions/odoo_theme/static/style.scss +++ b/extensions/odoo_theme/static/style.scss @@ -284,11 +284,8 @@ header.o_main_header { padding-left: 1rem; li { - &.toctree_l2 { - padding-left: .2rem; - } > a.reference { - padding-left: .8rem; + padding-left: .875rem; } a { @@ -315,7 +312,7 @@ header.o_main_header { > i[class^="i-"] { display: inline-block; - margin-right: .2rem; + margin-right: .125rem; @include o-transition(rotate, .3s); font-size: .75rem; font-weight: $fw_bold; From 451f1ccee76f138870a1a53a5063efbb70d5979b Mon Sep 17 00:00:00 2001 From: ren-odoo Date: Tue, 1 Jun 2021 11:04:25 -0700 Subject: [PATCH 02/21] [IMP] Accounting: Update Chilean localization Add important explanation about Tax on Invoice lines. --- .../fiscal_localizations/localizations/chile.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/content/applications/finance/accounting/fiscal_localizations/localizations/chile.rst b/content/applications/finance/accounting/fiscal_localizations/localizations/chile.rst index 8e142d843..f2dc1d607 100644 --- a/content/applications/finance/accounting/fiscal_localizations/localizations/chile.rst +++ b/content/applications/finance/accounting/fiscal_localizations/localizations/chile.rst @@ -384,7 +384,10 @@ You can manually change the document type if needed. .. image:: media/Chile15.png :align: center :alt: Document type selection on invoices. - + +.. important:: + Documents type 33: Electronic Invoice must have at least one item with tax, otherwise the SII + rejects the document validation. Validation and DTE Status ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -716,4 +719,4 @@ You can find this report in :menuselection:`Accounting --> Accounting --> Report .. image:: media/Chile38.png :align: center - :alt: Parameters to required to generate the Report Propuesta F29 \ No newline at end of file + :alt: Parameters to required to generate the Report Propuesta F29 From d409bc0639df60e6d84517fbdc71c54c2c7db8e7 Mon Sep 17 00:00:00 2001 From: Olivier Dony Date: Thu, 3 Jun 2021 17:34:51 +0200 Subject: [PATCH 03/21] [FIX] legal: fix confusing /12.0 pdf links --- content/legal.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/content/legal.rst b/content/legal.rst index b48159377..e00b2503d 100644 --- a/content/legal.rst +++ b/content/legal.rst @@ -31,7 +31,7 @@ Terms and Conditions .. |download_enterprise_en| image:: legal/img/pdf.svg :alt: Download Odoo Enterprise Agreement - :target: https://www.odoo.com/documentation/12.0/odoo_enterprise_agreement.pdf + :target: https://www.odoo.com/documentation/14.0/odoo_enterprise_agreement.pdf .. |view_partnership_en| image:: legal/img/txt.svg :alt: View Odoo Partnership Agreement @@ -39,7 +39,7 @@ Terms and Conditions .. |download_partnership_en| image:: legal/img/pdf.svg :alt: Download Odoo Partnership Agreement - :target: https://www.odoo.com/documentation/12.0/odoo_partnership_agreement.pdf + :target: https://www.odoo.com/documentation/14.0/odoo_partnership_agreement.pdf .. |view_terms_of_sale_en| image:: legal/img/txt.svg :alt: View Terms of Sale @@ -51,7 +51,7 @@ Terms and Conditions .. |download_enterprise_fr| image:: legal/img/pdf.svg :alt: Download Odoo Enterprise Agreement (FR) - :target: https://www.odoo.com/documentation/12.0/odoo_enterprise_agreement_fr.pdf + :target: https://www.odoo.com/documentation/14.0/odoo_enterprise_agreement_fr.pdf .. |view_enterprise_fr| image:: legal/img/txt.svg :alt: View Odoo Enterprise Agreement (FR) @@ -59,7 +59,7 @@ Terms and Conditions .. |download_partnership_fr| image:: legal/img/pdf.svg :alt: Download Odoo Partnership Agreement (FR) - :target: https://www.odoo.com/documentation/12.0/odoo_partnership_agreement_fr.pdf + :target: https://www.odoo.com/documentation/14.0/odoo_partnership_agreement_fr.pdf .. |view_enterprise_nl| image:: legal/img/txt.svg :alt: View Odoo Enterprise Agreement (NL) @@ -71,7 +71,7 @@ Terms and Conditions .. |download_terms_of_sale_fr| image:: legal/img/pdf.svg :alt: Download Odoo Terms of Sale (FR) - :target: https://www.odoo.com/documentation/12.0/terms_of_sale_fr.pdf + :target: https://www.odoo.com/documentation/14.0/terms_of_sale_fr.pdf .. |view_terms_of_sale_fr| image:: legal/img/txt.svg :alt: View Terms of Sale (FR) @@ -79,7 +79,7 @@ Terms and Conditions .. |download_enterprise_nl| image:: legal/img/pdf.svg :alt: Download Odoo Enterprise Agreement (NL) - :target: https://www.odoo.com/documentation/12.0/odoo_enterprise_agreement_nl.pdf + :target: https://www.odoo.com/documentation/14.0/odoo_enterprise_agreement_nl.pdf .. |download_partnership_nl| image:: legal/img/pdf.svg :alt: Download Odoo Partnership Agreement (NL) @@ -87,7 +87,7 @@ Terms and Conditions .. |download_enterprise_de| image:: legal/img/pdf.svg :alt: Download Odoo Enterprise Agreement (DE) - :target: https://www.odoo.com/documentation/12.0/odoo_enterprise_agreement_de.pdf + :target: https://www.odoo.com/documentation/14.0/odoo_enterprise_agreement_de.pdf .. |view_enterprise_de| image:: legal/img/txt.svg :alt: View Odoo Enterprise Agreement (DE) @@ -95,7 +95,7 @@ Terms and Conditions .. |download_partnership_de| image:: legal/img/pdf.svg :alt: Download Odoo Partnership Agreement (DE) - :target: https://www.odoo.com/documentation/12.0/odoo_partnership_agreement_de.pdf + :target: https://www.odoo.com/documentation/14.0/odoo_partnership_agreement_de.pdf .. |view_partnership_de| image:: legal/img/txt.svg :alt: View Odoo Partnership Agreement (DE) @@ -103,7 +103,7 @@ Terms and Conditions .. |download_enterprise_es| image:: legal/img/pdf.svg :alt: Download Odoo Enterprise Agreement (ES) - :target: https://www.odoo.com/documentation/12.0/odoo_enterprise_agreement_es.pdf + :target: https://www.odoo.com/documentation/14.0/odoo_enterprise_agreement_es.pdf .. |view_enterprise_es| image:: legal/img/txt.svg :alt: View Odoo Partnership Agreement (ES) @@ -111,7 +111,7 @@ Terms and Conditions .. |download_partnership_es| image:: legal/img/pdf.svg :alt: Download Odoo Partnership Agreement (ES) - :target: https://www.odoo.com/documentation/12.0/odoo_partnership_agreement_es.pdf + :target: https://www.odoo.com/documentation/14.0/odoo_partnership_agreement_es.pdf .. |view_partnership_es| image:: legal/img/txt.svg :alt: View Odoo Partnership Agreement (ES) From b33ce0a6ca5ad323a09354d3c6ddb763433584d9 Mon Sep 17 00:00:00 2001 From: Ivan Yelizariev // IEL Date: Wed, 2 Jun 2021 11:35:14 +0200 Subject: [PATCH 04/21] [FIX] dev: remove confusing phrase "US states" the file contains other countries states too --- content/developer/reference/data.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/developer/reference/data.rst b/content/developer/reference/data.rst index bff1e4860..948e9600b 100644 --- a/content/developer/reference/data.rst +++ b/content/developer/reference/data.rst @@ -276,7 +276,7 @@ For this case, data files can also use csv_, this is often the case for for :term:`external identifiers` (used for creation or update) * each row thereafter creates a new record -Here's the first lines of the data file defining US states +Here's the first lines of the data file defining country states ``res.country.state.csv`` .. literalinclude:: static/res.country.state.csv From 675f7bc8995e9068cbf1a3f3ed31f80a0586a97a Mon Sep 17 00:00:00 2001 From: "Antoine Vandevenne (anv)" Date: Fri, 4 Jun 2021 11:37:17 +0200 Subject: [PATCH 05/21] [FIX] odoo_theme: highlight all occurrences of a same entry in the menu When a page is referenced multiple times in the global toctree, only its latest TOC entry was highlighted (and expanded if it's a TOC page). This commit allows a page to be referenced multiple times at any level of the global TOC while correctly highlighting all of its TOC entries. task-2551473 --- extensions/odoo_theme/static/js/menu.js | 28 ++++++++++++++++--------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/extensions/odoo_theme/static/js/menu.js b/extensions/odoo_theme/static/js/menu.js index 2f4d3aef7..cc56dbd72 100644 --- a/extensions/odoo_theme/static/js/menu.js +++ b/extensions/odoo_theme/static/js/menu.js @@ -21,22 +21,30 @@ * TOC entries (
  • elements) that are on the path of the displayed page receive the * `o_active_toc_entry` class, and their related (parent) TOC entry list (
      elements) receive * the `show` (Bootstrap) class. - * Also, the deepest TOC entry receives the `o_deepest_active_toc_entry` class, and its child - * TOC entry list receives the `show` class. + * Also, the deepest TOC entries of their respective branch receive the + * `o_deepest_active_toc_entry` class, and their child TOC entry lists receive the `show` class. */ const _flagActiveTocEntriesAndLists = () => { - let deepestTocEntry = undefined; + const regexLayer = /\btoctree-l(?\d+)\b/; + let lastLayer = undefined; + let lastTocEntry = undefined; + const deepestTocEntries = []; this.navigationMenu.querySelectorAll('.current').forEach(element => { if (element.tagName === 'UL') { - // Expand all related
        - element.classList.add('show'); + element.classList.add('show'); // Expand all related
          } else if (element.tagName === 'LI') { - // Highlight all
        • in the active hierarchy - element.classList.add('o_active_toc_entry'); - deepestTocEntry = element; + element.classList.add('o_active_toc_entry'); // Highlight all active
        • + let match = regexLayer.exec(element.className); + let currentLayer = parseInt(match.groups.layer, 10); + if (lastLayer && currentLayer <= lastLayer) { // We just moved to another branch + deepestTocEntries.push(lastTocEntry); + } + lastLayer = currentLayer; + lastTocEntry = element; } }) - if (deepestTocEntry) { + deepestTocEntries.push(lastTocEntry); // The last TOC entry is the deepest of its branch + deepestTocEntries.forEach(deepestTocEntry => { const childTocEntryList = deepestTocEntry.querySelector('ul'); if (childTocEntryList) { childTocEntryList.classList.add('show'); @@ -44,7 +52,7 @@ deepestTocEntry = deepestTocEntry.parentElement.parentElement; } deepestTocEntry.classList.add('o_deepest_active_toc_entry'); - } + }); }; document.addEventListener('scroll', () => { From 4c6947da4fd324079fbb9fbda42e00f5dcc95426 Mon Sep 17 00:00:00 2001 From: "Antoine Vandevenne (anv)" Date: Fri, 4 Jun 2021 13:49:20 +0200 Subject: [PATCH 06/21] [IMP] Makefile: update build instructions following merge of 46c21826 --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 6cf6b2267..7b7a6ea87 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,6 @@ # Makefile for Sphinx documentation -# Pass WORKERS=auto for parallel build +# Pass WORKERS=1 for single-worker build ifndef WORKERS WORKERS = auto endif From 6940f68cb5ba5d2de2651dfa375856438becba56 Mon Sep 17 00:00:00 2001 From: Jonathan Castillo Date: Fri, 28 May 2021 15:55:15 +0200 Subject: [PATCH 07/21] [MOV] general: single docs content up to their parent pages This commit is part of a larger work to improve the documentation's structure. The toctree structure used to add levels to create categories and make the structure visually more understandable. With the new version of the documentation, plenty of these categories are now redundant. This commit improves the structure of the "general" section: - it moves the content of the doc "in_app_purchase" to its parent page "multi_companies" - it moves the content of the doc "tags/take_tags" to "odoo_basics/tags" - it moves the content of the doc "manage_multi_companies" to its parent page "multi_companies" task-2535899 --- .../applications/general/in_app_purchase.rst | 75 +++++++++- .../in_app_purchase/{media => }/image1.png | Bin .../in_app_purchase/{media => }/image2.png | Bin .../in_app_purchase/{media => }/image3.png | Bin .../in_app_purchase/{media => }/image4.png | Bin .../in_app_purchase/in_app_purchase.rst | 71 ---------- .../applications/general/multi_companies.rst | 133 +++++++++++++++++- .../access_rights_multi_companies.png | Bin .../{media => }/create_js_store_us.png | Bin .../{media => }/document_layout.png | Bin .../multi_companies/{media => }/favicon.png | Bin .../inter_company_transactions.png | Bin .../{media => }/invoice_inter_company.png | Bin .../manage_multi_companies.rst | 132 ----------------- .../multi_companies_menu_dashboard.png | Bin .../{media => }/product_form_company.png | Bin .../purchase_order_inter_company.png | Bin .../general/odoo_basics/users.rst | 2 +- content/applications/general/tags.rst | 64 ++++++++- .../general/tags/{media => }/create_tags.png | Bin .../tags/{media => }/create_tags_fly.png | Bin .../general/tags/{media => }/delete.png | Bin .../tags/{media => }/mkt_automation.png | Bin .../general/tags/{media => }/reporting.png | Bin .../general/tags/{media => }/tags_colors.png | Bin .../applications/general/tags/take_tags.rst | 66 --------- .../events/integrations/integration_sms.rst | 2 +- .../marketing_automation/overview/segment.rst | 2 +- .../sales/crm/acquire_leads/lead_mining.rst | 2 +- .../services/project/tasks/get_started.rst | 2 +- redirects.txt | 5 +- 31 files changed, 269 insertions(+), 287 deletions(-) rename content/applications/general/in_app_purchase/{media => }/image1.png (100%) rename content/applications/general/in_app_purchase/{media => }/image2.png (100%) rename content/applications/general/in_app_purchase/{media => }/image3.png (100%) rename content/applications/general/in_app_purchase/{media => }/image4.png (100%) delete mode 100644 content/applications/general/in_app_purchase/in_app_purchase.rst rename content/applications/general/multi_companies/{media => }/access_rights_multi_companies.png (100%) rename content/applications/general/multi_companies/{media => }/create_js_store_us.png (100%) rename content/applications/general/multi_companies/{media => }/document_layout.png (100%) rename content/applications/general/multi_companies/{media => }/favicon.png (100%) rename content/applications/general/multi_companies/{media => }/inter_company_transactions.png (100%) rename content/applications/general/multi_companies/{media => }/invoice_inter_company.png (100%) delete mode 100644 content/applications/general/multi_companies/manage_multi_companies.rst rename content/applications/general/multi_companies/{media => }/multi_companies_menu_dashboard.png (100%) rename content/applications/general/multi_companies/{media => }/product_form_company.png (100%) rename content/applications/general/multi_companies/{media => }/purchase_order_inter_company.png (100%) rename content/applications/general/tags/{media => }/create_tags.png (100%) rename content/applications/general/tags/{media => }/create_tags_fly.png (100%) rename content/applications/general/tags/{media => }/delete.png (100%) rename content/applications/general/tags/{media => }/mkt_automation.png (100%) rename content/applications/general/tags/{media => }/reporting.png (100%) rename content/applications/general/tags/{media => }/tags_colors.png (100%) delete mode 100644 content/applications/general/tags/take_tags.rst diff --git a/content/applications/general/in_app_purchase.rst b/content/applications/general/in_app_purchase.rst index 53caf9d4a..60549a9f7 100644 --- a/content/applications/general/in_app_purchase.rst +++ b/content/applications/general/in_app_purchase.rst @@ -1,8 +1,71 @@ -=============== -In-App Purchase -=============== +===================== +In-App Purchase (IAP) +===================== -.. toctree:: - :titlesonly: +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 my database. - in_app_purchase/in_app_purchase \ No newline at end of file +Buying Credits +============== + +Each IAP Service relies on prepaid credits to work and has its own pricing. To consult my current +balance or to recharge my account, go to :menuselection:`Settings --> Odoo IAP --> View my +Services`. + +.. image:: in_app_purchase/image1.png + :align: center + +.. tip:: + If I am on Odoo Online (SAAS) and have the Enterprise version, I benefit from free credits to + test our IAP features. + +IAP accounts +============ + +Credits to use IAP services are stored on IAP accounts, which are specific to each service and +database. By default, IAP accounts are common to all companies, but can be restricted to specific +ones. Activate the :doc:`Developer mode `, then go to +:menuselection:`Technical Settings --> IAP Account`. + +.. image:: in_app_purchase/image2.png + :align: center + +IAP Portal +========== + +The IAP Portal is a platform regrouping my IAP Services. It is accessible from +:menuselection:`Settings app --> Odoo IAP --> View my Services`. From there, I can view my current +balance, recharge my credits, review my consumption and set a reminder to when credits are low. + +.. image:: in_app_purchase/image3.png + :align: center + +Get notified when credits are low +================================= + +To be notified when it’s time to recharge my credits, I’ll go to my IAP Portal through +:menuselection:`Settings app --> Odoo IAP --> View my Services`, unfold a service and mark the +Receive threshold warning option. Then, I’ll provide a minimum amount of credits and email +addresses. Now, every time that the limit is reached, an automatic reminder will be sent to by +email! + +.. image:: in_app_purchase/image4.png + :align: center + +IAP services available +====================== + +Different services are available depending on the hosting type of your Database: + +- *Odoo Online (SAAS)*: only the IAP services provided by Odoo can be used (i.e. the SMS, Snailmail, + Reveal and Partner Autocomplete features); +- *Odoo.sh and Odoo Enterprise (on-premise)*: both the services provided by Odoo and by third-party + apps can be used. + +Offering my own services +======================== + +I am more than welcome to offer my own IAP services through Odoo Apps! It is the perfect opportunity +to get recurring revenue for an ongoing service use rather than — and possibly instead of — a sole +initial purchase. Please, find more information at: :doc:`In-App Purchase +`. diff --git a/content/applications/general/in_app_purchase/media/image1.png b/content/applications/general/in_app_purchase/image1.png similarity index 100% rename from content/applications/general/in_app_purchase/media/image1.png rename to content/applications/general/in_app_purchase/image1.png diff --git a/content/applications/general/in_app_purchase/media/image2.png b/content/applications/general/in_app_purchase/image2.png similarity index 100% rename from content/applications/general/in_app_purchase/media/image2.png rename to content/applications/general/in_app_purchase/image2.png diff --git a/content/applications/general/in_app_purchase/media/image3.png b/content/applications/general/in_app_purchase/image3.png similarity index 100% rename from content/applications/general/in_app_purchase/media/image3.png rename to content/applications/general/in_app_purchase/image3.png diff --git a/content/applications/general/in_app_purchase/media/image4.png b/content/applications/general/in_app_purchase/image4.png similarity index 100% rename from content/applications/general/in_app_purchase/media/image4.png rename to content/applications/general/in_app_purchase/image4.png diff --git a/content/applications/general/in_app_purchase/in_app_purchase.rst b/content/applications/general/in_app_purchase/in_app_purchase.rst deleted file mode 100644 index 582932185..000000000 --- a/content/applications/general/in_app_purchase/in_app_purchase.rst +++ /dev/null @@ -1,71 +0,0 @@ -================================================== -General guide about In-App Purchase (IAP) Services -================================================== - -In-App Purchases (IAP) gives access to additional services through Odoo. For instance, it allows me -to send SMS Text Messages or to send Invoices by post directly from my database. - -Buying Credits -============== - -Each IAP Service relies on prepaid credits to work and has its own pricing. To consult my current -balance or to recharge my account, go to :menuselection:`Settings --> Odoo IAP --> -View my Services`. - -.. image:: media/image1.png - :align: center - -.. tip:: - If I am on Odoo Online (SAAS) and have the Enterprise version, I benefit from free credits to - test our IAP features. - -IAP accounts -============ - -Credits to use IAP services are stored on IAP accounts, which are specific to each service and -database. By default, IAP accounts are common to all companies, but can be restricted to specific -ones. Activate the :doc:`Developer mode `, then go to -:menuselection:`Technical Settings --> IAP Account`. - -.. image:: media/image2.png - :align: center - -IAP Portal -========== - -The IAP Portal is a platform regrouping my IAP Services. It is accessible from -:menuselection:`Settings app --> Odoo IAP --> View my Services`. From there, I can view my current -balance, recharge my credits, review my consumption and set a reminder to when credits are low. - -.. image:: media/image3.png - :align: center - -Get notified when credits are low -================================= - -To be notified when it’s time to recharge my credits, I’ll go to my IAP Portal through -:menuselection:`Settings app --> Odoo IAP --> View my Services`, unfold a service and mark the -Receive threshold warning option. Then, I’ll provide a minimum amount of credits and email -addresses. Now, every time that the limit is reached, an automatic reminder will be sent to by -email! - -.. image:: media/image4.png - :align: center - -IAP services available -====================== - -Different services are available depending on the hosting type of your Database: - -- *Odoo Online (SAAS)*: only the IAP services provided by Odoo can be used (i.e. the SMS, Snailmail, - Reveal and Partner Autocomplete features); -- *Odoo.sh and Odoo Enterprise (on-premise)*: both the services provided by Odoo and by third-party - apps can be used. - -Offering my own services -======================== - -I am more than welcome to offer my own IAP services through Odoo Apps! It is the perfect opportunity -to get recurring revenue for an ongoing service use rather than — and possibly instead of — a sole -initial purchase. Please, find more information at: :doc:`In-App Purchase -`. diff --git a/content/applications/general/multi_companies.rst b/content/applications/general/multi_companies.rst index 8349f9c79..e2403c69a 100644 --- a/content/applications/general/multi_companies.rst +++ b/content/applications/general/multi_companies.rst @@ -2,7 +2,134 @@ Multi Companies =============== -.. toctree:: - :titlesonly: +A centralized management environment allows you to select multiple companies simultaneously and set +their specific warehouses, customers, equipment, and contacts. It provides you the ability to +generate reports of aggregated figures without switching interfaces, which facilitates daily tasks +and the overall management process. - multi_companies/manage_multi_companies \ No newline at end of file +Manage companies and records +============================ + +Go to :menuselection:`Settings --> Manage Companies` and fill in the form with your company’s +information. If a *Parent Company* is selected, records are shared between the two companies (as +long as both environments are active). + +.. image:: multi_companies/create_js_store_us.png + :align: center + :alt: Overview of a new company's form in Odoo + +.. tip:: + Activate the :doc:`Developer mode ` to choose a *Favicon* + for each of your companies, and easily identify them by the browser tabs. Set your + favicons’ files size to 16x16 or 32x32 pixels. JPG, PNG, GIF, and ICO are extensions accepted. + + .. image:: multi_companies/favicon.png + :align: center + :height: 200 + :alt: View of a web browser and the favicon for a specific company chosen in Odoo + +Switch between or select multiple companies by enabling their selection boxes to activate them. The +grayed company is the one which environment is in use. To switch environments, click on the +company’s name. In the example below, the user has access to three companies, two are activated, and +the environment in use is of *JS Store US*. + +.. image:: multi_companies/multi_companies_menu_dashboard.png + :align: center + :alt: View of the companies menu through the main dashboard in Odoo + +Data such as Products, Contacts, and Equipment can be shared or set to be shown for a specific +company only. To do so, on their forms, choose between: + +- *A blank field*: the record is shared within all companies. +- *Adding a company*: the record is visible to users logged in to that specific company. + +.. image:: multi_companies/product_form_company.png + :align: center + :alt: View of a product's form emphasizing the company field in Odoo Sales + +Employees' access +================= + +Once companies are created, manage your employees' :doc:`Access Rights ` +for *Multi Companies*. + +.. image:: multi_companies/access_rights_multi_companies.png + :align: center + :alt: View of an user form emphasizing the multi companies field under the access rights tabs + in Odoo + +| If a user has multiple companies *activated* on his database, and he is **editing** a record, + the editing happens on the record's related company. +| Example: if editing a sale order issued under JS Store US while working on the JS Store Belgium + environment, the changes are applied under JS Store US (the company from which the sale order + was issued). +| When **creating** a record, the company taken into account is: + +- The current company (the one active) or, +- No company is set (on products and contacts’ forms for example) or, +- The company set is the one linked to the document (the same as if a record is being edited). + +Documents’ format +================= + +To set documents' formats according to each company, *activate* and *select* the respective one and, +under *Settings*, click on *Configure Document Layout*. + +.. image:: multi_companies/document_layout.png + :align: center + :alt: View of the settings page emphasizing the document layout field in Odoo + +Inter-Company Transactions +========================== + +First, make sure each one of your companies is properly set in relation to: + +- :doc:`Chart of Accounts + <../finance/accounting/getting_started/initial_configuration/chart_of_accounts>` +- :doc:`Taxes <../finance/accounting/taxation/taxes/default_taxes>` +- :doc:`Fiscal Positions <../finance/accounting/taxation/taxes/fiscal_positions>` +- :doc:`Journals <../finance/accounting/bank/setup/bank_accounts>` +- :doc:`Fiscal Localizations + <../finance/accounting/fiscal_localizations/overview/fiscal_localization_packages>` +- :doc:`Pricelists <../sales/sales/products_prices/prices/pricing>` +- :doc:`Warehouses <../inventory_and_mrp/inventory/management/warehouses/warehouse_creation>` + +Now, activate the *Inter-Company Transactions* option under *Settings*. With the respective company +*activated* and *selected*, choose if you would like operations between companies to be synchronized +at an invoice/bills level or at a sales/purchase orders level. + +.. image:: multi_companies/inter_company_transactions.png + :align: center + :alt: View of the settings page emphasizing the inter company transaction field in Odoo + +- **Synchronize invoice/bills**: generates a bill/invoice when a company confirms a bill/invoice for + the selected company. + + *Example:* an invoice posted on JS Store Belgium, for JS Store US, automatically creates a vendor + bill on the JS Store US, from the JS Store Belgium. + +.. image:: multi_companies/invoice_inter_company.png + :align: center + :alt: View of an invoice for JS Store US created on JS Store Belgium in Odoo + +- **Synchronize sales/purchase order**: generates a drafted purchase/sales order using the selected + company warehouse when a sales/purchase order is confirmed for the selected company. If instead of + a drafted purchase/sales order you rather have it validated, enable *Automatic Validation*. + + *Example:* when a sale order for JS Store US is confirmed on JS Store Belgium, a purchase order + on JS Store Belgium is automatically created (and confirmed if the *Automatic Validation* feature + was enabled). + +.. image:: multi_companies/purchase_order_inter_company.png + :align: center + :alt: View of the purchase created on JS Store US from JS Store Belgium in Odoo + +.. note:: + Products have to be configured as *Can be sold* and must be shared between the companies. + +.. tip:: + Remember to test all workflows as an user other than the administrator. + +.. seealso:: + - :doc:`Multi-company Guidelines ` + - :doc:`../finance/accounting/others/multicurrencies/how_it_works` diff --git a/content/applications/general/multi_companies/media/access_rights_multi_companies.png b/content/applications/general/multi_companies/access_rights_multi_companies.png similarity index 100% rename from content/applications/general/multi_companies/media/access_rights_multi_companies.png rename to content/applications/general/multi_companies/access_rights_multi_companies.png diff --git a/content/applications/general/multi_companies/media/create_js_store_us.png b/content/applications/general/multi_companies/create_js_store_us.png similarity index 100% rename from content/applications/general/multi_companies/media/create_js_store_us.png rename to content/applications/general/multi_companies/create_js_store_us.png diff --git a/content/applications/general/multi_companies/media/document_layout.png b/content/applications/general/multi_companies/document_layout.png similarity index 100% rename from content/applications/general/multi_companies/media/document_layout.png rename to content/applications/general/multi_companies/document_layout.png diff --git a/content/applications/general/multi_companies/media/favicon.png b/content/applications/general/multi_companies/favicon.png similarity index 100% rename from content/applications/general/multi_companies/media/favicon.png rename to content/applications/general/multi_companies/favicon.png diff --git a/content/applications/general/multi_companies/media/inter_company_transactions.png b/content/applications/general/multi_companies/inter_company_transactions.png similarity index 100% rename from content/applications/general/multi_companies/media/inter_company_transactions.png rename to content/applications/general/multi_companies/inter_company_transactions.png diff --git a/content/applications/general/multi_companies/media/invoice_inter_company.png b/content/applications/general/multi_companies/invoice_inter_company.png similarity index 100% rename from content/applications/general/multi_companies/media/invoice_inter_company.png rename to content/applications/general/multi_companies/invoice_inter_company.png diff --git a/content/applications/general/multi_companies/manage_multi_companies.rst b/content/applications/general/multi_companies/manage_multi_companies.rst deleted file mode 100644 index 280c0009b..000000000 --- a/content/applications/general/multi_companies/manage_multi_companies.rst +++ /dev/null @@ -1,132 +0,0 @@ -Multi Companies -=============== - -A centralized management environment allows you to select multiple companies simultaneously and set -their specific warehouses, customers, equipment, and contacts. It provides you the ability to -generate reports of aggregated figures without switching interfaces, which facilitates daily tasks -and the overall management process. - -Manage companies and records ----------------------------- - -Go to :menuselection:`Settings --> Manage Companies` and fill in the form with your company’s -information. If a *Parent Company* is selected, records are shared between the two companies (as -long as both environments are active). - -.. image:: media/create_js_store_us.png - :align: center - :alt: Overview of a new company's form in Odoo - -.. tip:: - Activate the :doc:`Developer mode <../developer_mode/activate>` to choose a *Favicon* - for each of your companies, and easily identify them by the browser tabs. Set your - favicons’ files size to 16x16 or 32x32 pixels. JPG, PNG, GIF, and ICO are extensions accepted. - - .. image:: media/favicon.png - :align: center - :height: 200 - :alt: View of a web browser and the favicon for a specific company chosen in Odoo - -Switch between or select multiple companies by enabling their selection boxes to activate them. The -grayed company is the one which environment is in use. To switch environments, click on the -company’s name. In the example below, the user has access to three companies, two are activated, and -the environment in use is of *JS Store US*. - -.. image:: media/multi_companies_menu_dashboard.png - :align: center - :alt: View of the companies menu through the main dashboard in Odoo - -Data such as Products, Contacts, and Equipment can be shared or set to be shown for a specific -company only. To do so, on their forms, choose between: - -- *A blank field*: the record is shared within all companies. -- *Adding a company*: the record is visible to users logged in to that specific company. - -.. image:: media/product_form_company.png - :align: center - :alt: View of a product's form emphasizing the company field in Odoo Sales - -Employees' access ------------------ - -Once companies are created, manage your employees' :doc:`Access Rights <../odoo_basics/users>` -for *Multi Companies*. - -.. image:: media/access_rights_multi_companies.png - :align: center - :alt: View of an user form emphasizing the multi companies field under the access rights tabs - in Odoo - -| If a user has multiple companies *activated* on his database, and he is **editing** a record, - the editing happens on the record's related company. -| Example: if editing a sale order issued under JS Store US while working on the JS Store Belgium - environment, the changes are applied under JS Store US (the company from which the sale order - was issued). -| When **creating** a record, the company taken into account is: - -- The current company (the one active) or, -- No company is set (on products and contacts’ forms for example) or, -- The company set is the one linked to the document (the same as if a record is being edited). - -Documents’ format ------------------ - -To set documents' formats according to each company, *activate* and *select* the respective one and, -under *Settings*, click on *Configure Document Layout*. - -.. image:: media/document_layout.png - :align: center - :alt: View of the settings page emphasizing the document layout field in Odoo - -Inter-Company Transactions --------------------------- - -First, make sure each one of your companies is properly set in relation to: - -- :doc:`Chart of Accounts <../../finance/accounting/getting_started/initial_configuration/chart_of_accounts>` -- :doc:`Taxes <../../finance/accounting/taxation/taxes/default_taxes>` -- :doc:`Fiscal Positions <../../finance/accounting/taxation/taxes/fiscal_positions>` -- :doc:`Journals <../../finance/accounting/bank/setup/bank_accounts>` -- :doc:`Fiscal Localizations <../../finance/accounting/fiscal_localizations/overview/fiscal_localization_packages>` -- :doc:`Pricelists <../../sales/sales/products_prices/prices/pricing>` -- :doc:`Warehouses <../../inventory_and_mrp/inventory/management/warehouses/warehouse_creation>` - -Now, activate the *Inter-Company Transactions* option under *Settings*. With the respective company -*activated* and *selected*, choose if you would like operations between companies to be synchronized -at an invoice/bills level or at a sales/purchase orders level. - -.. image:: media/inter_company_transactions.png - :align: center - :alt: View of the settings page emphasizing the inter company transaction field in Odoo - -- **Synchronize invoice/bills**: generates a bill/invoice when a company confirms a bill/invoice for - the selected company. - - *Example:* an invoice posted on JS Store Belgium, for JS Store US, automatically creates a vendor - bill on the JS Store US, from the JS Store Belgium. - -.. image:: media/invoice_inter_company.png - :align: center - :alt: View of an invoice for JS Store US created on JS Store Belgium in Odoo - -- **Synchronize sales/purchase order**: generates a drafted purchase/sales order using the selected - company warehouse when a sales/purchase order is confirmed for the selected company. If instead of - a drafted purchase/sales order you rather have it validated, enable *Automatic Validation*. - - *Example:* when a sale order for JS Store US is confirmed on JS Store Belgium, a purchase order - on JS Store Belgium is automatically created (and confirmed if the *Automatic Validation* feature - was enabled). - -.. image:: media/purchase_order_inter_company.png - :align: center - :alt: View of the purchase created on JS Store US from JS Store Belgium in Odoo - -.. note:: - Products have to be configured as *Can be sold* and must be shared between the companies. - -.. tip:: - Remember to test all workflows as an user other than the administrator. - -.. seealso:: - - :doc:`Multi-company Guidelines ` - - :doc:`../../finance/accounting/others/multicurrencies/how_it_works` diff --git a/content/applications/general/multi_companies/media/multi_companies_menu_dashboard.png b/content/applications/general/multi_companies/multi_companies_menu_dashboard.png similarity index 100% rename from content/applications/general/multi_companies/media/multi_companies_menu_dashboard.png rename to content/applications/general/multi_companies/multi_companies_menu_dashboard.png diff --git a/content/applications/general/multi_companies/media/product_form_company.png b/content/applications/general/multi_companies/product_form_company.png similarity index 100% rename from content/applications/general/multi_companies/media/product_form_company.png rename to content/applications/general/multi_companies/product_form_company.png diff --git a/content/applications/general/multi_companies/media/purchase_order_inter_company.png b/content/applications/general/multi_companies/purchase_order_inter_company.png similarity index 100% rename from content/applications/general/multi_companies/media/purchase_order_inter_company.png rename to content/applications/general/multi_companies/purchase_order_inter_company.png diff --git a/content/applications/general/odoo_basics/users.rst b/content/applications/general/odoo_basics/users.rst index 5ee1d0527..159535ccc 100644 --- a/content/applications/general/odoo_basics/users.rst +++ b/content/applications/general/odoo_basics/users.rst @@ -202,5 +202,5 @@ the user can have access. :alt: View of a user’s form emphasizing the multi companies field in Odoo .. seealso:: - - :doc:`../multi_companies/manage_multi_companies` + - :doc:`../multi_companies` - :doc:`../../settings/users_and_features` \ No newline at end of file diff --git a/content/applications/general/tags.rst b/content/applications/general/tags.rst index 307ee61ad..4b9ac81b6 100644 --- a/content/applications/general/tags.rst +++ b/content/applications/general/tags.rst @@ -2,7 +2,65 @@ Tags ==== -.. toctree:: - :titlesonly: +Tags work like keywords or labels that will help you to categorize your work, as well as make +objectives and goals clearer and available for everyone instantly. They are also a useful source of +filtering, helping you boost productivity. - tags/take_tags \ No newline at end of file + +Where can I use and how do I create tags? +========================================= + +| Tags can be used in numerous applications going from *CRM*, *Project*, *Contacts*, *Marketing + Automation*, etc. +| On *CRM* for instance, under :menuselection:`CRM --> Configuration --> Tags` you can create new or + edit existing ones. + +.. image:: tags/create_tags.png + :align: center + :height: 300 + :alt: Click on Create to create Tags in Odoo + +You can also create them on the fly. + +.. image:: tags/create_tags_fly.png + :align: center + :alt: Type the name of the tag on the field and create and edit a tag in Odoo + +Choose specific colors for each tag to help identify them, or *Hide in Kanban*, simply by +clicking on the tag once it is created. + +.. image:: tags/tags_colors.png + :align: center + :height: 260 + :alt: Click on the tag and choose a color in Odoo + +Remove tags from a task or from the database +============================================ + +Click on the *x* to delete a tag from a specific task or contact. To delete it from your +database, go to :menuselection:`CRM --> Configuration --> Tags --> Action --> Delete`. + +.. image:: tags/delete.png + :align: center + :alt: Select a tag and click on action then delete to delete it from the database in Odoo + +Use tags as a parameter +======================= + +On the *Marketing Automation* application, for example, you can re-use tags as a parameter to +specify a niche of records for your campaign. + +.. image:: tags/mkt_automation.png + :align: center + :height: 430 + :alt: Apply tags as filters in Odoo Marketing Automation application + +Use tags for reporting +====================== + +To get the information you need in an organized format and for a specific purpose, you can also +add tags. + +.. image:: tags/reporting.png + :align: center + :alt: Apply tags to create reports in Odoo diff --git a/content/applications/general/tags/media/create_tags.png b/content/applications/general/tags/create_tags.png similarity index 100% rename from content/applications/general/tags/media/create_tags.png rename to content/applications/general/tags/create_tags.png diff --git a/content/applications/general/tags/media/create_tags_fly.png b/content/applications/general/tags/create_tags_fly.png similarity index 100% rename from content/applications/general/tags/media/create_tags_fly.png rename to content/applications/general/tags/create_tags_fly.png diff --git a/content/applications/general/tags/media/delete.png b/content/applications/general/tags/delete.png similarity index 100% rename from content/applications/general/tags/media/delete.png rename to content/applications/general/tags/delete.png diff --git a/content/applications/general/tags/media/mkt_automation.png b/content/applications/general/tags/mkt_automation.png similarity index 100% rename from content/applications/general/tags/media/mkt_automation.png rename to content/applications/general/tags/mkt_automation.png diff --git a/content/applications/general/tags/media/reporting.png b/content/applications/general/tags/reporting.png similarity index 100% rename from content/applications/general/tags/media/reporting.png rename to content/applications/general/tags/reporting.png diff --git a/content/applications/general/tags/media/tags_colors.png b/content/applications/general/tags/tags_colors.png similarity index 100% rename from content/applications/general/tags/media/tags_colors.png rename to content/applications/general/tags/tags_colors.png diff --git a/content/applications/general/tags/take_tags.rst b/content/applications/general/tags/take_tags.rst deleted file mode 100644 index 6f26c125c..000000000 --- a/content/applications/general/tags/take_tags.rst +++ /dev/null @@ -1,66 +0,0 @@ -====================== -Take Advantage of Tags -====================== - -Tags work like keywords or labels that will help you to categorize your work, as well as make -objectives and goals clearer and available for everyone instantly. They are also a useful source of -filtering, helping you to boost productivity. - - -Where can I use and how do I create tags? -========================================= - -| Tags can be used in numerous applications going from *CRM*, *Project*, *Contacts*, *Marketing - Automation*, etc. -| On *CRM* for instance, under :menuselection:`CRM --> Configuration --> Tags` you can create new or - edit existing ones. - -.. image:: media/create_tags.png - :align: center - :height: 300 - :alt: Click on Create to create Tags in Odoo - -You can also create them on the fly. - -.. image:: media/create_tags_fly.png - :align: center - :alt: Type the name of the tag on the field and create and edit a tag in Odoo - -Choose specific colors for each tag to help identify them, or *Hide in Kanban*, simply by -clicking on the tag once it is created. - -.. image:: media/tags_colors.png - :align: center - :height: 260 - :alt: Click on the tag and choose a color in Odoo - -Remove tags from a task or from the database -============================================ - -Click on the *x* to delete a tag from a specific task or contact. To delete it from your -database, go to :menuselection:`CRM --> Configuration --> Tags --> Action --> Delete`. - -.. image:: media/delete.png - :align: center - :alt: Select a tag and click on action then delete to delete it from the database in Odoo - -Use tags as a parameter -======================= - -On the *Marketing Automation* application, for example, you can re-use tags as a parameter to -specify a niche of records for your campaign. - -.. image:: media/mkt_automation.png - :align: center - :height: 430 - :alt: Apply tags as filters in Odoo Marketing Automation application - -Use tags for reporting -====================== - -To get the information you need in an organized format and for a specific purpose, you can also -add tags. - -.. image:: media/reporting.png - :align: center - :alt: Apply tags to create reports in Odoo diff --git a/content/applications/marketing/events/integrations/integration_sms.rst b/content/applications/marketing/events/integrations/integration_sms.rst index d5cd2ab4c..60edb4136 100644 --- a/content/applications/marketing/events/integrations/integration_sms.rst +++ b/content/applications/marketing/events/integrations/integration_sms.rst @@ -64,7 +64,7 @@ Speakers*. .. note:: Credits are required to be able to send SMSs. For more information about Pricing :doc:`click here <../../sms_marketing/pricing/pricing_and_faq>`, and, about IAP Services :doc:`here - `. + `. diff --git a/content/applications/marketing/marketing_automation/overview/segment.rst b/content/applications/marketing/marketing_automation/overview/segment.rst index 5cca09f34..aea881464 100644 --- a/content/applications/marketing/marketing_automation/overview/segment.rst +++ b/content/applications/marketing/marketing_automation/overview/segment.rst @@ -64,4 +64,4 @@ Use cases .. seealso:: - :doc:`automate_actions` - - :doc:`/applications/general/tags/take_tags` + - :doc:`/applications/general/tags` diff --git a/content/applications/sales/crm/acquire_leads/lead_mining.rst b/content/applications/sales/crm/acquire_leads/lead_mining.rst index 53aff7150..d4982e0bd 100644 --- a/content/applications/sales/crm/acquire_leads/lead_mining.rst +++ b/content/applications/sales/crm/acquire_leads/lead_mining.rst @@ -68,5 +68,5 @@ Credits`; or go to :menuselection:`Settings --> In-App Purchases --> View my Ser If you are on Odoo Online (SAAS) and have the Enterprise version, you benefit from free trial credits to test the feature. .. seealso:: - * :doc:`In-App Purchases (IAP) ` + * :doc:`In-App Purchases (IAP) ` diff --git a/content/applications/services/project/tasks/get_started.rst b/content/applications/services/project/tasks/get_started.rst index 7ea7ff2e7..f9fcda4d9 100644 --- a/content/applications/services/project/tasks/get_started.rst +++ b/content/applications/services/project/tasks/get_started.rst @@ -80,7 +80,7 @@ Drag and drop tasks to change their stage and define colors to help you identify :alt: Choose a color to identify your task in Odoo Project .. seealso:: - - :doc:`/applications/general/tags/take_tags` + - :doc:`/applications/general/tags` diff --git a/redirects.txt b/redirects.txt index 5de69f0ba..6bc041f4f 100644 --- a/redirects.txt +++ b/redirects.txt @@ -195,6 +195,9 @@ discuss/overview.rst applications/productivity/discuss/overview/get_started.rst crm/optimize/onsip.rst applications/general/voip/onsip.rst # crm/optimize/* --> general/voip/* crm/optimize/setup.rst applications/general/voip/asterisk.rst # crm/optimize/setup --> general/voip/asterisk -general/odoo_basics/add_user.rst applications/general/odoo_basics/users.rst # add_user --> users +general/odoo_basics/add_user.rst applications/general/odoo_basics/users.rst # add_user -> users +applications/general/in_app_purchase/in_app_purchase.rst applications/general/in_app_purchase.rst # in_app_purchase/in_app_purchase -> in_app_purchase +applications/general/tags/take_tags.rst applications/general/tags.rst # tags/take_tags -> tags +applications/general/multi_companies/manage_multi_companies.rst applications/general/multi_companies.rst # multi_companies/manage_multi_companies -> multi_companies applications/finance/sign/overview/signature_validity.rst applications/finance/sign.rst #sign/overview/signature_validity -> sign/* From 2b6f89f26e8bd59382482603e81b34bb919819a6 Mon Sep 17 00:00:00 2001 From: Jonathan Castillo Date: Thu, 27 May 2021 17:52:28 +0200 Subject: [PATCH 08/21] [MOV] general: move "payment_acquirer" content up to its parent page This commit is part of a larger work to improve the documentation's structure. The toctree structure used to add levels to create categories and make the structure visually more understandable. With the new version of the documentation, plenty of these categories are now redundant. This commit improves the structure of the "general" section: - moves the content of "payment_acquirers/payment_acquirers" to its parent page, as main content for this category. It also improves the content of the note about sensitive data. task-2535899 --- .../customer_payments/online_payment.rst | 2 +- .../general/payment_acquirers.rst | 235 +++++++++++++++++- ...cquirers-activation.png => activation.png} | Bin .../general/payment_acquirers/authorize.rst | 6 +- ...-online-payment.png => online-payment.png} | Bin .../payment_acquirers/payment_acquirers.rst | 226 ----------------- .../general/payment_acquirers/paypal.rst | 2 +- .../marketing/events/overview/tickets.rst | 2 +- .../shopper_experience/payment_acquirer.rst | 2 +- redirects.txt | 1 + 10 files changed, 239 insertions(+), 237 deletions(-) rename content/applications/general/payment_acquirers/{media/payment-acquirers-activation.png => activation.png} (100%) rename content/applications/general/payment_acquirers/{media/payment-acquirers-online-payment.png => online-payment.png} (100%) delete mode 100644 content/applications/general/payment_acquirers/payment_acquirers.rst diff --git a/content/applications/finance/accounting/receivables/customer_payments/online_payment.rst b/content/applications/finance/accounting/receivables/customer_payments/online_payment.rst index 3c1064c62..cd244c9aa 100644 --- a/content/applications/finance/accounting/receivables/customer_payments/online_payment.rst +++ b/content/applications/finance/accounting/receivables/customer_payments/online_payment.rst @@ -42,4 +42,4 @@ They can choose which Payment Acquirer to use by clicking on *Pay Now*. .. seealso:: - - :doc:`/applications/general/payment_acquirers/payment_acquirers` + - :doc:`/applications/general/payment_acquirers` diff --git a/content/applications/general/payment_acquirers.rst b/content/applications/general/payment_acquirers.rst index 1557e43a9..6c75e33ca 100644 --- a/content/applications/general/payment_acquirers.rst +++ b/content/applications/general/payment_acquirers.rst @@ -1,12 +1,239 @@ -================= -Payment Acquirers -================= +:show-content: + +================================================ +Payment Acquirers (Credit Cards, Online Payment) +================================================ .. toctree:: :titlesonly: - payment_acquirers/payment_acquirers payment_acquirers/wire_transfer payment_acquirers/authorize payment_acquirers/paypal payment_acquirers/stripe + +Odoo embeds several **payment acquirers** that allow your customers to pay on their *Customer +Portals* or your *eCommerce website*. They can pay Sales Orders, invoices, or subscriptions with +recurring payments with their favorite payment methods such as **Credit Cards**. + +Offering several payment methods increases the chances of getting paid in time, or even immediately, +as you make it more convenient for your customers to pay with the payment method they prefer and +trust. + +.. image:: payment_acquirers/online-payment.png + :align: center + :alt: Pay online in the customer portal and select which payment acquirer to use. + +.. note:: + Odoo apps delegate the handling of sensitive information to the certified payment acquirer so + that you don't ever have to worry about PCI compliance. + + This means that no sensitive information (such as credit card numbers or credentials) is stored + on Odoo servers or Odoo databases hosted elsewhere. Instead, Odoo apps use a unique reference + number to the data stored safely in the payment acquirers' systems. + +.. _payment_acquirers/acquirers: + +Payment Acquirers +================= + +From an accounting perspective, we can distinguish two types of payment acquirers: the payments that +go directly on the bank account and follow the usual reconciliation workflow, and the payment +acquirers that are third-party services and require you to follow another accounting workflow. + +.. _payment_acquirers/bank_payments: + +Bank Payments +------------- + +- | :doc:`Wire Transfer ` + | When selected, Odoo displays your payment information with a payment reference. You have to + approve the payment manually once you have received it on your bank account. +- | SEPA Direct Debit + | Your customers can sign a SEPA Direct Debit mandate online and get their bank account charged + directly. :doc:`Click here <../finance/accounting/receivables/customer_payments/batch_sdd>` for more + information about this payment method. + +.. _payment_acquirers/online_providers: + +Online Payment Providers +------------------------ + ++-------------------------------------+----------------------+-----------+------------+-----------------+ +| | Redirection to | Payment | Save Cards | Capture Amount | +| | the acquirer website | from Odoo | | Manually | ++=====================================+======================+===========+============+=================+ +| Adyen | ✔ | | | | ++-------------------------------------+----------------------+-----------+------------+-----------------+ +| Alipay | ✔ | | | | ++-------------------------------------+----------------------+-----------+------------+-----------------+ +| :doc:`Authorize.Net | ✔ | ✔ | ✔ | ✔ | +| ` | | | | | ++-------------------------------------+----------------------+-----------+------------+-----------------+ +| Buckaroo | ✔ | | | | ++-------------------------------------+----------------------+-----------+------------+-----------------+ +| Ingenico | ✔ | ✔ | ✔ | | ++-------------------------------------+----------------------+-----------+------------+-----------------+ +| :doc:`PayPal | ✔ | | | | +| ` | | | | | ++-------------------------------------+----------------------+-----------+------------+-----------------+ +| PayUMoney | ✔ | | | | ++-------------------------------------+----------------------+-----------+------------+-----------------+ +| SIPS | ✔ | | | | ++-------------------------------------+----------------------+-----------+------------+-----------------+ +| Stripe | ✔ | ✔ | ✔ | | ++-------------------------------------+----------------------+-----------+------------+-----------------+ + +.. note:: + Some of these Online Payment Providers can also be added as :doc:`Bank Accounts + <../finance/accounting/bank/setup/bank_accounts>`, but this is **not** the same process as adding them + as Payment Acquirers. Payment Acquirers allow customers to pay online, and Bank Accounts are + added and configured on your Accounting app to do a bank reconciliation, which is an accounting + control process. + +.. _payment_acquirers/configuration: + +Configuration +============= + +Some of the features described in this section are available only with some Payment Acquirers. Refer +to :ref:`the table above ` for more details. + +.. _payment_acquirers/add_new: + +Add a new Payment Acquirer +-------------------------- + +To add a new Payment acquirer and make it available to your customers, go to +:menuselection:`Accounting --> Configuration --> Payment Acquirers`, look for your payment acquirer, +install the related module, and activate it. To do so, open the payment acquirer and change its +state from *Disabled* to *Enabled*. + +.. image:: payment_acquirers/activation.png + :align: center + :alt: Click on install, then on activate to make the payment acquirer available on Odoo. + +.. warning:: + We recommend using the *Test Mode* on a duplicated database or a test database. The Test Mode is + meant to be used with your test/sandbox credentials, but Odoo generates Sales Orders and Invoices + as usual. It isn't always possible to cancel an invoice, and this could create some issues with + your invoices numbering if you were to test your payment acquirers on your main database. + +.. _payment_acquirers/credentials_tab: + +Credentials tab +~~~~~~~~~~~~~~~ + +If not done yet, go to the **Online Payment Provider**'s website, create an account, and make sure +to have the credentials required for third-party use. Odoo requires these credentials to communicate +with the Payment Acquirer and get the confirmation of the *payment authentication*. + +The form in this section is specific to the Payment Acquirer you are configuring. Please refer to +the related documentation for more information. + +.. _payment_acquirers/configuration_tab: + +Configuration tab +~~~~~~~~~~~~~~~~~ + +You can change the Payment Acquirer front-end appearance by modifying its name under the **Displayed +as** field and which credit card icons to display under the **Supported Payment Icons** field. + +.. _payment_acquirers/save_cards: + +Save and reuse Credit Cards +*************************** + +With the **Save Cards** feature, Odoo can store **Payment Tokens** in your database, which can be +used for subsequent payments, without having to reenter the payment details. This is particularly +useful for subscriptions' recurring payments. + +.. _payment_acquirers/capture_amount: + +Place a hold on a card +********************** + +If the **Capture Amount Manually** field is enabled, the funds are reserved for a few days on the +customer's card, but not charged yet. You must then go to the related Sales Order and manually +*capture* the funds before its automatic cancellation, or *void the transaction* to unlock the funds +from the customer's card. + +.. _payment_acquirers/payment_flow: + +Payment Flow +************ + +Choose in the **Payment Flow** field if to redirect the user to the payment acquirer's portal to +authenticate the payment, or if to stay on the current page and authenticate the payment from Odoo. + +.. note:: + Some features are available only if you select *Redirection to the acquirer website*. + +.. _payment_acquirers/countries: + +Countries +********* + +Restrict the use of the Payment Acquirer to a selection of countries. Leave this field blank to make +the Payment Acquirer available to all countries. + +.. _payment_acquirers/journal: + +Payment Journal +*************** + +The **Payment Journal** selected for your Payment Acquirer must be a *Bank* journal. + +.. important:: + In many cases, Odoo automatically creates a new **Journal** and a new **Account** when you + activate a new Payment Acquirer. Both of them are preset to work out-of-the-box, but we strongly + recommend you to make sure these fields are correctly set according to your accounting needs, and + adapt them if necessary. + +.. _payment_acquirers/messages: + +Messages tab +~~~~~~~~~~~~ + +Change here the messages displayed by Odoo after a payment's confirmation or failure. + +.. _payment_acquirers/accounting: + +Accounting perspective +====================== + +The **Bank Payments** that go directly to one of your bank accounts follow their usual +reconciliation workflows. However, payments recorded with **Online Payment Providers** require you +to consider how you want to record your payments' journal entries. We recommend you to ask your +accountant for advice. + +Odoo default method is to record the payments on a *Current Assets Account*, on a dedicated *Bank +Journal*, once the *Payment Authentication* is confirmed. At some point, you transfer the funds from +the *Payment Acquirer* to your *Bank Account*. + +Here are the requirements for this to work: + +- Bank Journal + + - The Journal's **type** must be *Bank Journal*. + - Select the right **Default Debit Account** and **Default Credit Account**. + - | Under the *Advanced Settings* tab, make sure that **Posting** is set as *Post At Payment + Validation*. + | This implies that the Journal Entry is recorded directly when your Odoo database receives the + confirmation of the *Payment Authentication* from the Online Payment Provider. + +- Current Asset Account + + - The Account's **type** is *Current Assets* + - The Account must **Allow Reconciliation** + +.. note:: + In many cases, Odoo automatically creates a new **Journal** and a new **Current Asset Account** + when you activate a new Payment Acquirer. You can modify them if necessary. + +.. seealso:: + + - :doc:`../finance/accounting/receivables/customer_payments/recording` + - :doc:`payment_acquirers/wire_transfer` + - :doc:`payment_acquirers/authorize` + - :doc:`payment_acquirers/paypal` \ No newline at end of file diff --git a/content/applications/general/payment_acquirers/media/payment-acquirers-activation.png b/content/applications/general/payment_acquirers/activation.png similarity index 100% rename from content/applications/general/payment_acquirers/media/payment-acquirers-activation.png rename to content/applications/general/payment_acquirers/activation.png diff --git a/content/applications/general/payment_acquirers/authorize.rst b/content/applications/general/payment_acquirers/authorize.rst index 5437b0c3e..cec04d3da 100644 --- a/content/applications/general/payment_acquirers/authorize.rst +++ b/content/applications/general/payment_acquirers/authorize.rst @@ -10,7 +10,7 @@ provider, allowing businesses to accept **credit cards**. :alt: Authorize.Net logo This Payment Acquirer offers additional options that are not available for other :doc:`Payment -Acquirers `, such as the ability to process your customer's payment after +Acquirers <../payment_acquirers>`, such as the ability to process your customer's payment after delivery. Authorize.Net account @@ -47,7 +47,7 @@ Configuration --> Payment Acquirers`, open **Authorize.Net**, and change the **S Don't forget to click on *Save* once you've set everything up. .. note:: - Please refer to the :doc:`Payment Acquirers documentation ` to read how to + Please refer to the :doc:`Payment Acquirers documentation <../payment_acquirers>` to read how to configure this payment acquirer. Credentials @@ -113,5 +113,5 @@ order is canceled, you can click on *Void Transaction* to unlock the funds from .. seealso:: - `Authorize.Net: Getting Started Guide `__ - - :doc:`payment_acquirers` + - :doc:`../payment_acquirers` - :doc:`../../websites/ecommerce/shopper_experience/payment_acquirer` diff --git a/content/applications/general/payment_acquirers/media/payment-acquirers-online-payment.png b/content/applications/general/payment_acquirers/online-payment.png similarity index 100% rename from content/applications/general/payment_acquirers/media/payment-acquirers-online-payment.png rename to content/applications/general/payment_acquirers/online-payment.png diff --git a/content/applications/general/payment_acquirers/payment_acquirers.rst b/content/applications/general/payment_acquirers/payment_acquirers.rst deleted file mode 100644 index 475edd18b..000000000 --- a/content/applications/general/payment_acquirers/payment_acquirers.rst +++ /dev/null @@ -1,226 +0,0 @@ -================================================ -Payment Acquirers (Credit Cards, Online Payment) -================================================ - -Odoo embeds several **payment methods** that allow your customers to pay on their *Customer Portals* -or your *eCommerce website*. They can pay Sales Orders, invoices, or subscriptions with recurring -payments with their favorite payment acquirers, including **online payment providers** that accept -**Credit Cards**. - -Having several payment methods increases the chances of getting paid in time, or even immediately, -as you make it more convenient for your customers to pay with the payment method they prefer and -trust. - -.. image:: media/payment-acquirers-online-payment.png - :align: center - :alt: Pay online in the customer portal and select which payment acquirer to use. - -.. important:: - Odoo does not keep Credit Card numbers or credentials on its servers, nor is it stored on Odoo - databases hosted elsewhere. Instead, Odoo apps use a unique reference to the data stored in the - payment acquirers' systems, where the information is safely stored. This reference is useless - without your credentials for the payment acquirer. - -.. _payment_acquirers/acquirers: - -Payment Acquirers -================= - -From an accounting perspective, we can distinguish two types of payment acquirers: the payments that -go directly on the bank account and follow the usual reconciliation workflow, and the payment -acquirers that are third-party services and require you to follow another accounting workflow. - -.. _payment_acquirers/bank_payments: - -Bank Payments -------------- - -- | :doc:`Wire Transfer ` - | When selected, Odoo displays your payment information with a payment reference. You have to - approve the payment manually once you have received it on your bank account. -- | SEPA Direct Debit - | Your customers can sign a SEPA Direct Debit mandate online and get their bank account charged - directly. :doc:`Click here <../../finance/accounting/receivables/customer_payments/batch_sdd>` for more - information about this payment method. - -.. _payment_acquirers/online_providers: - -Online Payment Providers ------------------------- - -+-------------------------------------+----------------------+-----------+------------+-----------------+ -| | Redirection to | Payment | Save Cards | Capture Amount | -| | the acquirer website | from Odoo | | Manually | -+=====================================+======================+===========+============+=================+ -| Adyen | ✔ | | | | -+-------------------------------------+----------------------+-----------+------------+-----------------+ -| Alipay | ✔ | | | | -+-------------------------------------+----------------------+-----------+------------+-----------------+ -| :doc:`Authorize.Net ` | ✔ | ✔ | ✔ | ✔ | -+-------------------------------------+----------------------+-----------+------------+-----------------+ -| Buckaroo | ✔ | | | | -+-------------------------------------+----------------------+-----------+------------+-----------------+ -| Ingenico | ✔ | ✔ | ✔ | | -+-------------------------------------+----------------------+-----------+------------+-----------------+ -| :doc:`PayPal ` | ✔ | | | | -+-------------------------------------+----------------------+-----------+------------+-----------------+ -| PayUMoney | ✔ | | | | -+-------------------------------------+----------------------+-----------+------------+-----------------+ -| SIPS | ✔ | | | | -+-------------------------------------+----------------------+-----------+------------+-----------------+ -| Stripe | ✔ | ✔ | ✔ | | -+-------------------------------------+----------------------+-----------+------------+-----------------+ - -.. note:: - Some of these Online Payment Providers can also be added as :doc:`Bank Accounts - <../../finance/accounting/bank/setup/bank_accounts>`, but this is **not** the same process as adding them - as Payment Acquirers. Payment Acquirers allow customers to pay online, and Bank Accounts are - added and configured on your Accounting app to do a bank reconciliation, which is an accounting - control process. - -.. _payment_acquirers/configuration: - -Configuration -============= - -Some of the features described in this section are available only with some Payment Acquirers. Refer -to :ref:`the table above ` for more details. - -.. _payment_acquirers/add_new: - -Add a new Payment Acquirer --------------------------- - -To add a new Payment acquirer and make it available to your customers, go to -:menuselection:`Accounting --> Configuration --> Payment Acquirers`, look for your payment acquirer, -install the related module, and activate it. To do so, open the payment acquirer and change its -state from *Disabled* to *Enabled*. - -.. image:: media/payment-acquirers-activation.png - :align: center - :alt: Click on install, then on activate to make the payment acquirer available on Odoo. - -.. warning:: - We recommend using the *Test Mode* on a duplicated database or a test database. The Test Mode is - meant to be used with your test/sandbox credentials, but Odoo generates Sales Orders and Invoices - as usual. It isn't always possible to cancel an invoice, and this could create some issues with - your invoices numbering if you were to test your payment acquirers on your main database. - -.. _payment_acquirers/credentials_tab: - -Credentials tab -~~~~~~~~~~~~~~~ - -If not done yet, go to the **Online Payment Provider**'s website, create an account, and make sure -to have the credentials required for third-party use. Odoo requires these credentials to communicate -with the Payment Acquirer and get the confirmation of the *payment authentication*. - -The form in this section is specific to the Payment Acquirer you are configuring. Please refer to -the related documentation for more information. - -.. _payment_acquirers/configuration_tab: - -Configuration tab -~~~~~~~~~~~~~~~~~ - -You can change the Payment Acquirer front-end appearance by modifying its name under the **Displayed -as** field and which credit card icons to display under the **Supported Payment Icons** field. - -.. _payment_acquirers/save_cards: - -Save and reuse Credit Cards -*************************** - -With the **Save Cards** feature, Odoo can store **Payment Tokens** in your database, which can be -used for subsequent payments, without having to reenter the payment details. This is particularly -useful for subscriptions' recurring payments. - -.. _payment_acquirers/capture_amount: - -Place a hold on a card -********************** - -If the **Capture Amount Manually** field is enabled, the funds are reserved for a few days on the -customer's card, but not charged yet. You must then go to the related Sales Order and manually -*capture* the funds before its automatic cancellation, or *void the transaction* to unlock the funds -from the customer's card. - -.. _payment_acquirers/payment_flow: - -Payment Flow -************ - -Choose in the **Payment Flow** field if to redirect the user to the payment acquirer's portal to -authenticate the payment, or if to stay on the current page and authenticate the payment from Odoo. - -.. note:: - Some features are available only if you select *Redirection to the acquirer website*. - -.. _payment_acquirers/countries: - -Countries -********* - -Restrict the use of the Payment Acquirer to a selection of countries. Leave this field blank to make -the Payment Acquirer available to all countries. - -.. _payment_acquirers/journal: - -Payment Journal -*************** - -The **Payment Journal** selected for your Payment Acquirer must be a *Bank* journal. - -.. important:: - In many cases, Odoo automatically creates a new **Journal** and a new **Account** when you - activate a new Payment Acquirer. Both of them are preset to work out-of-the-box, but we strongly - recommend you to make sure these fields are correctly set according to your accounting needs, and - adapt them if necessary. - -.. _payment_acquirers/messages: - -Messages tab -~~~~~~~~~~~~ - -Change here the messages displayed by Odoo after a payment's confirmation or failure. - -.. _payment_acquirers/accounting: - -Accounting perspective -====================== - -The **Bank Payments** that go directly to one of your bank accounts follow their usual -reconciliation workflows. However, payments recorded with **Online Payment Providers** require you -to consider how you want to record your payments' journal entries. We recommend you to ask your -accountant for advice. - -Odoo default method is to record the payments on a *Current Assets Account*, on a dedicated *Bank -Journal*, once the *Payment Authentication* is confirmed. At some point, you transfer the funds from -the *Payment Acquirer* to your *Bank Account*. - -Here are the requirements for this to work: - -- Bank Journal - - - The Journal's **type** must be *Bank Journal*. - - Select the right **Default Debit Account** and **Default Credit Account**. - - | Under the *Advanced Settings* tab, make sure that **Posting** is set as *Post At Payment - Validation*. - | This implies that the Journal Entry is recorded directly when your Odoo database receives the - confirmation of the *Payment Authentication* from the Online Payment Provider. - -- Current Asset Account - - - The Account's **type** is *Current Assets* - - The Account must **Allow Reconciliation** - -.. note:: - In many cases, Odoo automatically creates a new **Journal** and a new **Current Asset Account** - when you activate a new Payment Acquirer. You can modify them if necessary. - -.. seealso:: - - - :doc:`../../finance/accounting/receivables/customer_payments/recording` - - :doc:`wire_transfer` - - :doc:`authorize` - - :doc:`paypal` \ No newline at end of file diff --git a/content/applications/general/payment_acquirers/paypal.rst b/content/applications/general/payment_acquirers/paypal.rst index cade12d69..ee0ae614a 100644 --- a/content/applications/general/payment_acquirers/paypal.rst +++ b/content/applications/general/payment_acquirers/paypal.rst @@ -203,5 +203,5 @@ when a fictitious transaction is completed. Run a test transaction from Odoo using the sandbox personal account. .. seealso:: - - :doc:`payment_acquirers` + - :doc:`../payment_acquirers` - :doc:`../../websites/ecommerce/shopper_experience/payment_acquirer` diff --git a/content/applications/marketing/events/overview/tickets.rst b/content/applications/marketing/events/overview/tickets.rst index 504fb84c3..43d827d08 100644 --- a/content/applications/marketing/events/overview/tickets.rst +++ b/content/applications/marketing/events/overview/tickets.rst @@ -50,4 +50,4 @@ among the payment methods you chose to have available. :alt: View of website transaction for Odoo Events .. seealso:: - - :doc:`/applications/general/payment_acquirers/payment_acquirers` + - :doc:`/applications/general/payment_acquirers` diff --git a/content/applications/websites/ecommerce/shopper_experience/payment_acquirer.rst b/content/applications/websites/ecommerce/shopper_experience/payment_acquirer.rst index d7cc5b7e2..fdd9e7fca 100644 --- a/content/applications/websites/ecommerce/shopper_experience/payment_acquirer.rst +++ b/content/applications/websites/ecommerce/shopper_experience/payment_acquirer.rst @@ -56,7 +56,7 @@ orders straight on. Select your **bank account** if you get paid immediately on your bank account. If you don't you can create a specific journal for the payment acquirer (type = Bank). That way, you can track online payments in an intermediary account of your books until you get paid into your bank - account (see :doc:`/applications/general/payment_acquirers/payment_acquirers`). + account (see :doc:`/applications/general/payment_acquirers`). Capture the payment after the delivery diff --git a/redirects.txt b/redirects.txt index 6bc041f4f..6d90944ab 100644 --- a/redirects.txt +++ b/redirects.txt @@ -199,5 +199,6 @@ general/odoo_basics/add_user.rst applications/general/odoo_basics/users.rst applications/general/in_app_purchase/in_app_purchase.rst applications/general/in_app_purchase.rst # in_app_purchase/in_app_purchase -> in_app_purchase applications/general/tags/take_tags.rst applications/general/tags.rst # tags/take_tags -> tags applications/general/multi_companies/manage_multi_companies.rst applications/general/multi_companies.rst # multi_companies/manage_multi_companies -> multi_companies +applications/general/payment_acquirers/payment_acquirers.rst applications/general/payment_acquirers.rst # payment_acquirers/payment_acquirers -> payment_acquirers applications/finance/sign/overview/signature_validity.rst applications/finance/sign.rst #sign/overview/signature_validity -> sign/* From 8c036a0321fdc69f062395decf4cf1c83e8a6c54 Mon Sep 17 00:00:00 2001 From: Jonathan Castillo Date: Thu, 27 May 2021 18:11:23 +0200 Subject: [PATCH 09/21] [IMP] general: merge all docs about unsplash into one doc This commit is part of a larger work to improve the documentation's structure. The toctree structure used to add levels to create categories and make the structure visually more understandable. With the new version of the documentation, plenty of these categories are now redundant. This commit merges all docs about unsplash into a single doc: - "unsplash/unsplash_access_key" -> unsplash - "unsplash/unsplash_application_id" -> unsplash task-2535899 --- content/applications/general.rst | 2 +- content/applications/general/unsplash.rst | 65 ++++++++++++++++-- .../unsplash/{media => }/accept_terms.png | Bin .../unsplash/{media => }/access_key.png | Bin .../unsplash/{media => }/app_id_url.png | Bin .../unsplash/{media => }/app_infos.png | Bin .../unsplash/{media => }/create_app.png | Bin .../{media => }/production_account.png | Bin .../unsplash/{media => }/select_app.png | Bin .../general/unsplash/unsplash_access_key.rst | 37 ---------- .../unsplash/unsplash_application_id.rst | 19 ----- redirects.txt | 2 + 12 files changed, 64 insertions(+), 61 deletions(-) rename content/applications/general/unsplash/{media => }/accept_terms.png (100%) rename content/applications/general/unsplash/{media => }/access_key.png (100%) rename content/applications/general/unsplash/{media => }/app_id_url.png (100%) rename content/applications/general/unsplash/{media => }/app_infos.png (100%) rename content/applications/general/unsplash/{media => }/create_app.png (100%) rename content/applications/general/unsplash/{media => }/production_account.png (100%) rename content/applications/general/unsplash/{media => }/select_app.png (100%) delete mode 100644 content/applications/general/unsplash/unsplash_access_key.rst delete mode 100644 content/applications/general/unsplash/unsplash_application_id.rst diff --git a/content/applications/general.rst b/content/applications/general.rst index 89fd52a2a..2e269a6db 100644 --- a/content/applications/general.rst +++ b/content/applications/general.rst @@ -6,7 +6,6 @@ General .. toctree:: general/odoo_basics - general/unsplash general/base_import general/multi_companies general/auth @@ -15,4 +14,5 @@ General general/voip general/in_app_purchase general/developer_mode + general/unsplash general/mobile diff --git a/content/applications/general/unsplash.rst b/content/applications/general/unsplash.rst index 5078c1d88..f78a27c24 100644 --- a/content/applications/general/unsplash.rst +++ b/content/applications/general/unsplash.rst @@ -2,8 +2,65 @@ Unsplash ======== -.. toctree:: - :titlesonly: +Generate an Unsplash access key +=============================== - unsplash/unsplash_access_key - unsplash/unsplash_application_id \ No newline at end of file +.. tip:: + **As a SaaS user**, you are ready to use Unsplash. You won't need to follow this guide to set up + Unsplash information since you will use our own Odoo Unsplash key in a transparent way. + +Generate an Unsplash access key for non-Saas users +-------------------------------------------------- + +- Create an account on `Unsplash.com `_. + +- Go to your `applications dashboard `_ and click on **New + Application**. + +.. image:: unsplash/create_app.png + :align: center + +- Accept the conditions and click on **Accept terms**. + +.. image:: unsplash/accept_terms.png + :align: center + +- You will be prompted to insert an **Application name** and a **Description**. Please prefix your + application name by "**Odoo:** " so that Unsplash can recognize it as an Odoo instance. Once done, + click on **Create application**. + +.. image:: unsplash/app_infos.png + :align: center + +- You should be redirected to your application details page. Scroll down a bit to find your **access + key**. + +.. image:: unsplash/access_key.png + :align: center + +.. warning:: + **As a non-SaaS user**, you won't be able to register for a production Unsplash key and will be + limited to your test key that has a restriction of 50 Unsplash requests per hour. + +Generate an Unsplash application ID +=================================== + +.. tip:: + You should first create and set up your Unsplash application. + +- Go to your `applications dashboard `_ and click on your + newly created Unsplash application under **Your applications**. + +.. image:: unsplash/select_app.png + :align: center + +- You will be redirected to your application details page. The **application ID** will be visible in + your browser's URL. The URL should be something like + ``https://unsplash.com/oauth/applications/`` + +.. image:: unsplash/app_id_url.png + :align: center + +.. warning:: + **As a non-SaaS user**, you won't be able to register for a production Unsplash key and will be + limited to your test key that has a 50 Unsplash requests per hour restriction. diff --git a/content/applications/general/unsplash/media/accept_terms.png b/content/applications/general/unsplash/accept_terms.png similarity index 100% rename from content/applications/general/unsplash/media/accept_terms.png rename to content/applications/general/unsplash/accept_terms.png diff --git a/content/applications/general/unsplash/media/access_key.png b/content/applications/general/unsplash/access_key.png similarity index 100% rename from content/applications/general/unsplash/media/access_key.png rename to content/applications/general/unsplash/access_key.png diff --git a/content/applications/general/unsplash/media/app_id_url.png b/content/applications/general/unsplash/app_id_url.png similarity index 100% rename from content/applications/general/unsplash/media/app_id_url.png rename to content/applications/general/unsplash/app_id_url.png diff --git a/content/applications/general/unsplash/media/app_infos.png b/content/applications/general/unsplash/app_infos.png similarity index 100% rename from content/applications/general/unsplash/media/app_infos.png rename to content/applications/general/unsplash/app_infos.png diff --git a/content/applications/general/unsplash/media/create_app.png b/content/applications/general/unsplash/create_app.png similarity index 100% rename from content/applications/general/unsplash/media/create_app.png rename to content/applications/general/unsplash/create_app.png diff --git a/content/applications/general/unsplash/media/production_account.png b/content/applications/general/unsplash/production_account.png similarity index 100% rename from content/applications/general/unsplash/media/production_account.png rename to content/applications/general/unsplash/production_account.png diff --git a/content/applications/general/unsplash/media/select_app.png b/content/applications/general/unsplash/select_app.png similarity index 100% rename from content/applications/general/unsplash/media/select_app.png rename to content/applications/general/unsplash/select_app.png diff --git a/content/applications/general/unsplash/unsplash_access_key.rst b/content/applications/general/unsplash/unsplash_access_key.rst deleted file mode 100644 index 7e28420ff..000000000 --- a/content/applications/general/unsplash/unsplash_access_key.rst +++ /dev/null @@ -1,37 +0,0 @@ -======================================================= -How to generate an Unsplash access key -======================================================= - -.. tip:: - **As an SaaS user**, you are ready to use Unsplash. You won't need to follow this guide to set up Unsplash information, since you will use our own Odoo Unsplash key in a transparent way. - -Generate an Unsplash access key for **non-Saas** users -====================================================== - -- Create an account on `Unsplash.com `_. - -- Go to your `applications dashboard `_ and click on **New Application**. - -.. image:: media/create_app.png - :align: center - -- Accept the conditions and click on **Accept terms**. - -.. image:: media/accept_terms.png - :align: center - -- You will be prompted to insert an **Application name** and a **Description**. Please prefix your application name by "**Odoo:** " so that Unsplash can recognize it as an Odoo instance. Once done, click on **Create application**. - -.. image:: media/app_infos.png - :align: center - -- You should be redirected to your application details page. Scroll down a bit to find your **access key**. - -.. image:: media/access_key.png - :align: center - -.. warning:: - **As a non-SaaS user**, you won't be able to register for a production Unsplash key and will be limited to your test key that has a restriction of 50 Unsplash requests per hour. - -.. seealso:: - * :doc:`unsplash_application_id` diff --git a/content/applications/general/unsplash/unsplash_application_id.rst b/content/applications/general/unsplash/unsplash_application_id.rst deleted file mode 100644 index 9707044ed..000000000 --- a/content/applications/general/unsplash/unsplash_application_id.rst +++ /dev/null @@ -1,19 +0,0 @@ -======================================================= -How to generate an Unsplash application ID -======================================================= - -.. tip:: - You should first create and set up your Unsplash application with this tutorial: :doc:`unsplash_access_key`. - -- Go to your `applications dashboard `_ and click on your newly created Unsplash application under **Your applications**. - -.. image:: media/select_app.png - :align: center - -- You will be redirected to your application details page. The **application ID** will be visible in your browser's URL. The URL should be something like ``https://unsplash.com/oauth/applications/`` - -.. image:: media/app_id_url.png - :align: center - -.. warning:: - **As a non-SaaS user**, you won't be able to register for a production Unsplash key and will be limited to your test key that has a 50 Unsplash requests per hour restriction. diff --git a/redirects.txt b/redirects.txt index 6d90944ab..1e0ac4fe6 100644 --- a/redirects.txt +++ b/redirects.txt @@ -200,5 +200,7 @@ applications/general/in_app_purchase/in_app_purchase.rst applications/general/in applications/general/tags/take_tags.rst applications/general/tags.rst # tags/take_tags -> tags applications/general/multi_companies/manage_multi_companies.rst applications/general/multi_companies.rst # multi_companies/manage_multi_companies -> multi_companies applications/general/payment_acquirers/payment_acquirers.rst applications/general/payment_acquirers.rst # payment_acquirers/payment_acquirers -> payment_acquirers +applications/general/unsplash/unsplash_access_key.rst applications/general/unsplash.rst # unsplash/unsplash_access_key -> unsplash +applications/general/unsplash/unsplash_application_id.rst applications/general/unsplash.rst # unsplash/unsplash_application_id -> unsplash applications/finance/sign/overview/signature_validity.rst applications/finance/sign.rst #sign/overview/signature_validity -> sign/* From 9493bbf4f4cb71c879b867755f9eccc92457faef Mon Sep 17 00:00:00 2001 From: Jonathan Castillo Date: Thu, 27 May 2021 18:42:42 +0200 Subject: [PATCH 10/21] [IMP] general: merge all docs about data import/export into one doc This commit is part of a larger work to improve the documentation's structure. The toctree structure used to add levels to create categories and make the structure visually more understandable. With the new version of the documentation, plenty of these categories are now redundant. This commit merges all docs about data import/export into a single doc: - base_import/import_faq -> export_import_data - base_import/adapt_template -> export_import_data - odoo_basics/export-data -> export_import_data task-2535899 --- content/applications/general.rst | 2 +- content/applications/general/base_import.rst | 9 -- .../general/base_import/adapt_template.rst | 50 ------ .../import_faq.rst => export_import_data.rst} | 148 +++++++++++++++--- ...d_party_application_product_categories.csv | 0 ...rnal_id_3rd_party_application_products.csv | 0 .../database_import_test.sql | 0 .../media => export_import_data}/dragdown.gif | Bin .../export-data-overview.png | Bin .../field_list.png | Bin .../import_button.png | Bin .../list-view-export.png | Bin .../m2m_customers_tags.csv | 0 .../o2m_customers_contacts.csv | 0 .../o2m_purchase_order_lines.csv | 0 ...order_functional_error_line_cant_adpat.csv | 0 content/applications/general/odoo_basics.rst | 3 +- .../general/odoo_basics/export-data.rst | 53 ------- redirects.txt | 3 + 19 files changed, 134 insertions(+), 134 deletions(-) delete mode 100644 content/applications/general/base_import.rst delete mode 100644 content/applications/general/base_import/adapt_template.rst rename content/applications/general/{base_import/import_faq.rst => export_import_data.rst} (70%) rename content/applications/general/{base_import/files => export_import_data}/External_id_3rd_party_application_product_categories.csv (100%) rename content/applications/general/{base_import/files => export_import_data}/External_id_3rd_party_application_products.csv (100%) rename content/applications/general/{base_import/files => export_import_data}/database_import_test.sql (100%) rename content/applications/general/{base_import/media => export_import_data}/dragdown.gif (100%) rename content/applications/general/{odoo_basics/media => export_import_data}/export-data-overview.png (100%) rename content/applications/general/{base_import/media => export_import_data}/field_list.png (100%) rename content/applications/general/{base_import/media => export_import_data}/import_button.png (100%) rename content/applications/general/{odoo_basics/media => export_import_data}/list-view-export.png (100%) rename content/applications/general/{base_import/files => export_import_data}/m2m_customers_tags.csv (100%) rename content/applications/general/{base_import/files => export_import_data}/o2m_customers_contacts.csv (100%) rename content/applications/general/{base_import/files => export_import_data}/o2m_purchase_order_lines.csv (100%) rename content/applications/general/{base_import/files => export_import_data}/purchase.order_functional_error_line_cant_adpat.csv (100%) delete mode 100644 content/applications/general/odoo_basics/export-data.rst diff --git a/content/applications/general.rst b/content/applications/general.rst index 2e269a6db..ea863936f 100644 --- a/content/applications/general.rst +++ b/content/applications/general.rst @@ -6,7 +6,7 @@ General .. toctree:: general/odoo_basics - general/base_import + general/export_import_data general/multi_companies general/auth general/tags diff --git a/content/applications/general/base_import.rst b/content/applications/general/base_import.rst deleted file mode 100644 index 92a43880a..000000000 --- a/content/applications/general/base_import.rst +++ /dev/null @@ -1,9 +0,0 @@ -=========== -Data Import -=========== - -.. toctree:: - :titlesonly: - - base_import/adapt_template - base_import/import_faq \ No newline at end of file diff --git a/content/applications/general/base_import/adapt_template.rst b/content/applications/general/base_import/adapt_template.rst deleted file mode 100644 index 468db7cc0..000000000 --- a/content/applications/general/base_import/adapt_template.rst +++ /dev/null @@ -1,50 +0,0 @@ -=============================== -How to adapt an import template -=============================== - -Import templates are provided in the import tool of the most common data to -import (contacts, products, bank statements, etc.). -You can open them with any spreadsheets software (Microsoft Office, -OpenOffice, Google Drive, etc.). - -How to customize the file -========================= - -* Remove columns you don't need. We advise to not remove the *ID* one (see - why here below). -* Set a unique ID to every single record by dragging down the ID sequencing. - -.. image:: media/dragdown.gif - :align: center - -* When you add a new column, Odoo might not be able to map it automatically if its - label doesn't fit any field of the system. - If so, find the corresponding field using the search. - - .. image:: media/field_list.png - :align: center - - Then, use the label you found in your import template in order to make it work - straight away the very next time you try to import. - -Why an “ID” column -================== - -The **ID** (External ID) is an unique identifier for the line item. -Feel free to use the one of your previous software to ease the transition to Odoo. - -Setting an ID is not mandatory when importing but it helps in many cases: - -* Update imports: you can import the same file several times without creating duplicates; -* Import relation fields (see here below). - -How to import relation fields -============================= - -An Odoo object is always related to many other objects (e.g. a product is linked -to product categories, attributes, vendors, etc.). To import those relations you need to -import the records of the related object first from their own list menu. - -You can do it using either the name of the related record or its ID. The ID is expected when -two records have the same name. In such a case add " / ID" at the end of the column title -(e.g. for product attributes: Product Attributes / Attribute / ID). \ No newline at end of file diff --git a/content/applications/general/base_import/import_faq.rst b/content/applications/general/export_import_data.rst similarity index 70% rename from content/applications/general/base_import/import_faq.rst rename to content/applications/general/export_import_data.rst index 61ccae0ac..e82c962d3 100644 --- a/content/applications/general/base_import/import_faq.rst +++ b/content/applications/general/export_import_data.rst @@ -1,17 +1,78 @@ -============================ -How to import data into Odoo -============================ +====================== +Export and import data +====================== + +.. _export-data: + +Export data from Odoo +===================== + +When working with a database, it sometimes is necessary to export your data in a distinct file. +Doing so can help to do reporting over your activities (even if Odoo offers a precise and easy +reporting tool with each available application). + +With Odoo, you can export the values from any field in any record. To do so, +activate the list view on the items that need to be exported, click on *Action*, and, then, +on *Export*. + +.. image:: export_import_data/list-view-export.png + :align: center + :alt: view of the different things to enable/click to export data + +Pretty simple, this action still comes with some specificities. In fact, +when clicking on *Export*, a pop-up window appears with several +options for the data to export: + +.. image:: export_import_data/export-data-overview.png + :align: center + :alt: overview of all the options to take into account when exporting data in Odoo + +#. With the *I want to update data* option ticked, the system only + shows the fields which can be imported. This is very helpful in + case you want to update existing records. Basically, this works + like a filter. Leaving the box unticked gives way more field + options because it shows all the fields, not just the ones which + can be imported. +#. When exporting, you can choose between two formats: .csv and .xls. + With .csv, items are separated with a comma, while .xls holds information about all the + worksheets in a file, including both content and formatting. +#. Those are the items you may want to export. Use the arrows to display + more sub-field options. Of course, you can use the search bar to + find specific fields more easily. To use the search option more + efficiently, display all the fields by clicking on all the + arrows! +#. The + button is there to add fields to the "to export" list. +#. The "handles" next to the selected fields allow you to move the fields up and down to + change the order in which they must be displayed in the exported + file. +#. The trashcan is there if you need to remove fields. +#. For recurring reports, it might be interesting to save export presets. + Select all the needed ones and click on the template bar. + There, click on *New template* and give a name to yours. The + next time you need to export the same list, simply select the + related template. + +.. tip:: + It’s good to keep the field’s external identifier in mind. For example, + *Related Company* is equal to *parent_id*. Doing so helps export + only what you would like to import next. + +.. _import-data: + +Import data into Odoo +===================== How to start ------------ + You can import data on any Odoo's business object using either Excel (.xlsx) or CSV (.csv) formats: contacts, products, bank statements, journal entries and even orders! Open the view of the object you want to populate and click *Import*. -.. image:: media/import_button.png - :align: center +.. image:: export_import_data/import_button.png + :align: center There you are provided with templates you can easily populate with your own data. Such templates can be imported in one click; @@ -24,21 +85,20 @@ How to adapt the template * We advise to not remove the **ID** one (see why in the next section). * Set a unique ID to every single record by dragging down the ID sequencing. -.. image:: media/dragdown.gif - :align: center +.. image:: export_import_data/dragdown.gif + :align: center * When you add a new column, Odoo might not be able to map it automatically if its label doesn't fit any field in Odoo. Don't worry! You can map new columns manually when you test the import. Search the list for the corresponding field. - .. image:: media/field_list.png - :align: center + .. image:: export_import_data/field_list.png + :align: center Then, use this field's label in your file in order to make it work straight on the very next time. - How to import from another application -------------------------------------- @@ -71,8 +131,8 @@ If that happens, you just have to check the ** Show fields of relation fields (advanced)** option, you will then be able to choose from the complete list of fields for each column. -.. image:: media/field_list.png - :align: center +.. image:: export_import_data/field_list.png + :align: center Where can I change the date import format? ------------------------------------------ @@ -174,10 +234,10 @@ with columns like "Field/External ID". The following two CSV files give you an e and their Categories. :download:`CSV file for categories -`. +`. :download:`CSV file for Products -`. +`. What can I do if I have multiple matches for a field? ----------------------------------------------------- @@ -198,7 +258,7 @@ The tags should be separated by a comma without any spacing. For example, if you to be linked to both tags 'Manufacturer' and 'Retailer' then you will encode "Manufacturer,Retailer" in the same column of your CSV file. -:download:`CSV file for Manufacturer, Retailer ` +:download:`CSV file for Manufacturer, Retailer ` How can I import a one2many relationship (e.g. several Order Lines of a Sales Order)? @@ -211,16 +271,16 @@ any information in the fields relative to the order. As an example, here is ``purchase.order_functional_error_line_cant_adpat.CSV`` file of some quotations you can import, based on demo data. -:download:`File for some Quotations `. +:download:`File for some Quotations `. The following CSV file shows how to import purchase orders with their respective purchase order lines: -:download:`Purchase orders with their respective purchase order lines `. +:download:`Purchase orders with their respective purchase order lines `. The following CSV file shows how to import customers and their respective contacts: -:download:`Customers and their respective contacts `. +:download:`Customers and their respective contacts `. Can I import several times the same record? ------------------------------------------- @@ -256,7 +316,7 @@ must be unique across all the records of all objects, so it's a good practice to As an example, suppose you have a SQL database with two tables you want to import: companies and persons. Each person belong to one company, so you will have to recreate the link between a person and the company he work for. (If you want to test this example, here is a :download:`dump of such a -PostgreSQL database `) +PostgreSQL database `) We will first export all companies and their "External ID". In PSQL, write the following command: @@ -298,3 +358,53 @@ original database). The two files produced are ready to be imported in Odoo without any modifications. After having imported these two CSV files, you will have 4 contacts and 3 companies. (the firsts two contacts are linked to the first company). You must first import the companies and then the persons. + +How to adapt an import template +=============================== + +Import templates are provided in the import tool of the most common data to +import (contacts, products, bank statements, etc.). +You can open them with any spreadsheets software (Microsoft Office, +OpenOffice, Google Drive, etc.). + +How to customize the file +------------------------- + +* Remove columns you don't need. We advise to not remove the *ID* one (see + why here below). +* Set a unique ID to every single record by dragging down the ID sequencing. + + .. image:: export_import_data/dragdown.gif + :align: center + +* When you add a new column, Odoo might not be able to map it automatically if its + label doesn't fit any field of the system. + If so, find the corresponding field using the search. + + .. image:: export_import_data/field_list.png + :align: center + + Then, use the label you found in your import template in order to make it work + straight away the very next time you try to import. + +Why an "ID" column +------------------ + +The **ID** (External ID) is an unique identifier for the line item. +Feel free to use the one of your previous software to ease the transition to Odoo. + +Setting an ID is not mandatory when importing but it helps in many cases: + +* Update imports: you can import the same file several times without creating duplicates; +* Import relation fields (see here below). + +How to import relation fields +----------------------------- + +An Odoo object is always related to many other objects (e.g. a product is linked +to product categories, attributes, vendors, etc.). To import those relations you need to +import the records of the related object first from their own list menu. + +You can do it using either the name of the related record or its ID. The ID is expected when +two records have the same name. In such a case add " / ID" at the end of the column title +(e.g. for product attributes: Product Attributes / Attribute / ID). \ No newline at end of file diff --git a/content/applications/general/base_import/files/External_id_3rd_party_application_product_categories.csv b/content/applications/general/export_import_data/External_id_3rd_party_application_product_categories.csv similarity index 100% rename from content/applications/general/base_import/files/External_id_3rd_party_application_product_categories.csv rename to content/applications/general/export_import_data/External_id_3rd_party_application_product_categories.csv diff --git a/content/applications/general/base_import/files/External_id_3rd_party_application_products.csv b/content/applications/general/export_import_data/External_id_3rd_party_application_products.csv similarity index 100% rename from content/applications/general/base_import/files/External_id_3rd_party_application_products.csv rename to content/applications/general/export_import_data/External_id_3rd_party_application_products.csv diff --git a/content/applications/general/base_import/files/database_import_test.sql b/content/applications/general/export_import_data/database_import_test.sql similarity index 100% rename from content/applications/general/base_import/files/database_import_test.sql rename to content/applications/general/export_import_data/database_import_test.sql diff --git a/content/applications/general/base_import/media/dragdown.gif b/content/applications/general/export_import_data/dragdown.gif similarity index 100% rename from content/applications/general/base_import/media/dragdown.gif rename to content/applications/general/export_import_data/dragdown.gif diff --git a/content/applications/general/odoo_basics/media/export-data-overview.png b/content/applications/general/export_import_data/export-data-overview.png similarity index 100% rename from content/applications/general/odoo_basics/media/export-data-overview.png rename to content/applications/general/export_import_data/export-data-overview.png diff --git a/content/applications/general/base_import/media/field_list.png b/content/applications/general/export_import_data/field_list.png similarity index 100% rename from content/applications/general/base_import/media/field_list.png rename to content/applications/general/export_import_data/field_list.png diff --git a/content/applications/general/base_import/media/import_button.png b/content/applications/general/export_import_data/import_button.png similarity index 100% rename from content/applications/general/base_import/media/import_button.png rename to content/applications/general/export_import_data/import_button.png diff --git a/content/applications/general/odoo_basics/media/list-view-export.png b/content/applications/general/export_import_data/list-view-export.png similarity index 100% rename from content/applications/general/odoo_basics/media/list-view-export.png rename to content/applications/general/export_import_data/list-view-export.png diff --git a/content/applications/general/base_import/files/m2m_customers_tags.csv b/content/applications/general/export_import_data/m2m_customers_tags.csv similarity index 100% rename from content/applications/general/base_import/files/m2m_customers_tags.csv rename to content/applications/general/export_import_data/m2m_customers_tags.csv diff --git a/content/applications/general/base_import/files/o2m_customers_contacts.csv b/content/applications/general/export_import_data/o2m_customers_contacts.csv similarity index 100% rename from content/applications/general/base_import/files/o2m_customers_contacts.csv rename to content/applications/general/export_import_data/o2m_customers_contacts.csv diff --git a/content/applications/general/base_import/files/o2m_purchase_order_lines.csv b/content/applications/general/export_import_data/o2m_purchase_order_lines.csv similarity index 100% rename from content/applications/general/base_import/files/o2m_purchase_order_lines.csv rename to content/applications/general/export_import_data/o2m_purchase_order_lines.csv diff --git a/content/applications/general/base_import/files/purchase.order_functional_error_line_cant_adpat.csv b/content/applications/general/export_import_data/purchase.order_functional_error_line_cant_adpat.csv similarity index 100% rename from content/applications/general/base_import/files/purchase.order_functional_error_line_cant_adpat.csv rename to content/applications/general/export_import_data/purchase.order_functional_error_line_cant_adpat.csv diff --git a/content/applications/general/odoo_basics.rst b/content/applications/general/odoo_basics.rst index 43de50b65..873685fc3 100644 --- a/content/applications/general/odoo_basics.rst +++ b/content/applications/general/odoo_basics.rst @@ -6,5 +6,4 @@ Basics :titlesonly: odoo_basics/choose_language - odoo_basics/users - odoo_basics/export-data \ No newline at end of file + odoo_basics/users \ No newline at end of file diff --git a/content/applications/general/odoo_basics/export-data.rst b/content/applications/general/odoo_basics/export-data.rst deleted file mode 100644 index 29f9fd1c0..000000000 --- a/content/applications/general/odoo_basics/export-data.rst +++ /dev/null @@ -1,53 +0,0 @@ -====================== -Export Data From Odoo -====================== - -When working with a database, it sometimes is necessary to export your data in a distinct file. -Doing so can help to do reporting over your activities (even if Odoo offers a precise and easy -reporting tool with each available application). - -With Odoo, you can export the values from any field in any record. To do so, -activate the list view on the items that need to be exported, click on *Action*, and, then, -on *Export*. - -.. image:: media/list-view-export.png - :align: center - :alt: view of the different things to enable/click to export data - -Pretty simple, this action still comes with some specificities. In fact, -when clicking on *Export*, a pop-up window appears with several -options for the data to export: - -.. image:: media/export-data-overview.png - :align: center - :alt: overview of all the options to take into account when exporting data in Odoo - -1. With the *I want to update data* option ticked, the system only - shows the fields which can be imported. This is very helpful in - case you want to update existing records. Basically, this works - like a filter. Leaving the box unticked gives way more field - options because it shows all the fields, not just the ones which - can be imported. -2. When exporting, you can choose between two formats: .csv and .xls. - With .csv, items are separated with a comma, while .xls holds information about all the - worksheets in a file, including both content and formatting. -3. Those are the items you may want to export. Use the arrows to display - more sub-field options. Of course, you can use the search bar to - find specific fields more easily. To use the search option more - efficiently, display all the fields by clicking on all the - arrows! -4. The + button is there to add fields to the “to export” list. -5. The “handles” next to the selected fields allow you to move the fields up and down to - change the order in which they must be displayed in the exported - file. -6. The trashcan is there if you need to remove fields. -7. For recurring reports, it might be interesting to save export presets. - Select all the needed ones and click on the template bar. - There, click on *New template* and give a name to yours. The - next time you need to export the same list, simply select the - related template. - -.. tip:: - It’s good to keep the field’s external identifier in mind. For example, - *Related Company* is equal to *parent_id*. Doing so helps export - only what you would like to import next. \ No newline at end of file diff --git a/redirects.txt b/redirects.txt index 1e0ac4fe6..982878556 100644 --- a/redirects.txt +++ b/redirects.txt @@ -202,5 +202,8 @@ applications/general/multi_companies/manage_multi_companies.rst applications/gen applications/general/payment_acquirers/payment_acquirers.rst applications/general/payment_acquirers.rst # payment_acquirers/payment_acquirers -> payment_acquirers applications/general/unsplash/unsplash_access_key.rst applications/general/unsplash.rst # unsplash/unsplash_access_key -> unsplash applications/general/unsplash/unsplash_application_id.rst applications/general/unsplash.rst # unsplash/unsplash_application_id -> unsplash +applications/general/base_import/import_faq.rst applications/general/export_import_data.rst # base_import/import_faq -> odoo_basics/import_data +applications/general/base_import/adapt_template.rst applications/general/export_import_data.rst # base_import/adapt_template -> odoo_basics/import_data +content/applications/general/odoo_basics/export-data.rst applications/general/export_import_data.rst # odoo_basics/export-data -> export_import_data applications/finance/sign/overview/signature_validity.rst applications/finance/sign.rst #sign/overview/signature_validity -> sign/* From 2fb77cf3fff63085ae257013c9a55bd7c8eb7841 Mon Sep 17 00:00:00 2001 From: Jonathan Castillo Date: Tue, 1 Jun 2021 18:13:47 +0200 Subject: [PATCH 11/21] [MOV] general: removes main "settings" section + move content This commit is part of a larger work to improve the documentation's structure. The toctree structure used to add levels to create categories and make the structure visually more understandable. With the new version of the documentation, plenty of these categories are now redundant. This commit: - removes the main "settings" section - move its content to general/odoo_basics - moves "general/mobile" content to "general" - moves the content of the doc "developer_mode/activate" to "general" - it replaces the references to that doc with `:ref:` directives rather than `:doc:` directives - it is worth noting that it also fixes plenty of links that previously referred to "developer_mode" (the category) rather than "developer_mode/activate" (the document) task-2535899 --- .../odoo_sh/getting_started/create.rst | 2 +- .../odoo_sh/getting_started/first_module.rst | 2 +- content/applications.rst | 1 - .../bank/feeds/bank_synchronization.rst | 3 +- .../finance/accounting/bank/feeds/ponto.rst | 4 +- .../localizations/argentina.rst | 4 +- .../localizations/colombia.rst | 2 +- .../localizations/france.rst | 6 +- .../localizations/mexico.rst | 4 +- .../reporting/overview/customize.rst | 2 +- content/applications/general.rst | 195 +++++++++++++++++- .../media => general}/browse_apps.png | Bin .../media => general}/browse_users.png | Bin .../media => }/button_location.png | Bin .../media => general}/deactivate_user.png | Bin .../applications/general/developer_mode.rst | 8 - .../general/developer_mode/activate.rst | 54 ----- .../applications/general/in_app_purchase.rst | 4 +- .../media => general}/list_users.png | Bin content/applications/general/mobile.rst | 13 -- .../{developer_mode/media => }/monkey.png | Bin .../applications/general/multi_companies.rst | 6 +- .../general/odoo_basics/users.rst | 9 +- .../{developer_mode/media => }/settings.png | Bin .../media => general}/settings_app.png | Bin .../{settings/media => general}/uninstall.png | Bin .../media => general}/uninstall_deps.png | Bin .../{developer_mode/media => }/url.png | Bin .../operations/barcode_nomenclature.rst | 2 +- .../management/planning/schedulers.rst | 3 +- .../reporting/inventory_valuation_config.rst | 2 +- .../overview/integrations_and_template.rst | 4 +- .../sms_marketing/pricing/pricing_and_faq.rst | 3 +- .../discuss/advanced/email_servers.rst | 13 +- .../discuss/advanced/email_template.rst | 4 +- .../productivity/studio/how_to/reports.rst | 4 +- .../studio/use_cases/models_fields.rst | 2 +- .../sales/sales/amazon_connector/manage.rst | 15 +- .../sales/sales/amazon_connector/setup.rst | 8 +- .../sales/sales/amazon_connector/update.rst | 4 +- .../sales/sales/ebay_connector/setup.rst | 2 +- .../overview/duplicate_a_planning.rst | 2 +- .../project/advanced/advanced_projects.rst | 6 +- .../project/advanced/profitability.rst | 6 +- .../services/timesheets/overview/time_off.rst | 4 +- content/applications/settings.rst | 8 - .../settings/users_and_features.rst | 126 ----------- .../websites/website/optimize/seo.rst | 15 +- redirects.txt | 3 + 49 files changed, 264 insertions(+), 291 deletions(-) rename content/applications/{settings/media => general}/browse_apps.png (100%) rename content/applications/{settings/media => general}/browse_users.png (100%) rename content/applications/general/{developer_mode/media => }/button_location.png (100%) rename content/applications/{settings/media => general}/deactivate_user.png (100%) mode change 100755 => 100644 delete mode 100644 content/applications/general/developer_mode.rst delete mode 100644 content/applications/general/developer_mode/activate.rst rename content/applications/{settings/media => general}/list_users.png (100%) delete mode 100644 content/applications/general/mobile.rst rename content/applications/general/{developer_mode/media => }/monkey.png (100%) rename content/applications/general/{developer_mode/media => }/settings.png (100%) rename content/applications/{settings/media => general}/settings_app.png (100%) rename content/applications/{settings/media => general}/uninstall.png (100%) rename content/applications/{settings/media => general}/uninstall_deps.png (100%) rename content/applications/general/{developer_mode/media => }/url.png (100%) delete mode 100644 content/applications/settings.rst delete mode 100644 content/applications/settings/users_and_features.rst diff --git a/content/administration/odoo_sh/getting_started/create.rst b/content/administration/odoo_sh/getting_started/create.rst index f44ff19cf..583a45364 100644 --- a/content/administration/odoo_sh/getting_started/create.rst +++ b/content/administration/odoo_sh/getting_started/create.rst @@ -151,7 +151,7 @@ Check your outgoing email servers There is a default mail server provided with Odoo.sh. To use it, there must be no enabled outgoing mail server configured in your database in :menuselection:`Settings --> Technical --> Outgoing Mail Servers` -(:doc:`Developer mode ` must be activated). +(:ref:`Developer mode ` must be activated). After the import of your database, all outgoing email servers are disabled so you use the Odoo.sh email server provided by default. diff --git a/content/administration/odoo_sh/getting_started/first_module.rst b/content/administration/odoo_sh/getting_started/first_module.rst index d2ad364b3..fdc7c6f93 100644 --- a/content/administration/odoo_sh/getting_started/first_module.rst +++ b/content/administration/odoo_sh/getting_started/first_module.rst @@ -263,7 +263,7 @@ and on your production you would not like your module to be installed automatica Your module may not appear directly in your apps to install either, you need to update your apps list first: -* activate the :doc:`Developer mode ` +* Activate the :ref:`developer mode ` * in the apps menu, click the *Update Apps List* button, * in the dialog that appears, click the *Update* button. diff --git a/content/applications.rst b/content/applications.rst index df8123d14..208da8203 100644 --- a/content/applications.rst +++ b/content/applications.rst @@ -12,5 +12,4 @@ Applications applications/marketing applications/services applications/productivity - applications/settings applications/general diff --git a/content/applications/finance/accounting/bank/feeds/bank_synchronization.rst b/content/applications/finance/accounting/bank/feeds/bank_synchronization.rst index ea3d38303..82fcfbb9e 100644 --- a/content/applications/finance/accounting/bank/feeds/bank_synchronization.rst +++ b/content/applications/finance/accounting/bank/feeds/bank_synchronization.rst @@ -121,8 +121,7 @@ database, please `submit a support ticket `_. How can I update my bank credentials? ------------------------------------- -You can update your credentials in -:doc:`Developer mode `. +You can update your credentials in :ref:`developer mode `. Then go to :menuselection:`Accounting --> Configuration --> Online Synchronization`, and open the Institution you want to edit, and click on *Update Credentials*. diff --git a/content/applications/finance/accounting/bank/feeds/ponto.rst b/content/applications/finance/accounting/bank/feeds/ponto.rst index 38256c711..632d8eb3b 100644 --- a/content/applications/finance/accounting/bank/feeds/ponto.rst +++ b/content/applications/finance/accounting/bank/feeds/ponto.rst @@ -82,8 +82,8 @@ Update your synchronization credentials You might have to update your Ponto credentials or modify the synchronization settings. -To do so, activate the :doc:`Developer Mode `, and go to -:menuselection:`Accounting --> Configuration --> Online Synchronization`. +To do so, activate the :ref:`developer mode `, and go to :menuselection:`Accounting +--> Configuration --> Online Synchronization`. Click on *Update Accounts* to enter your new Client ID and Secret ID, or click on *Edit* to modify the synchronization settings. diff --git a/content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst b/content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst index 9c906fbb5..451515d9f 100644 --- a/content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst +++ b/content/applications/finance/accounting/fiscal_localizations/localizations/argentina.rst @@ -274,8 +274,8 @@ with the same letter will share the same sequence. For example: Sequences ~~~~~~~~~ In case that you want to synchronize the next number in the sequence in Odoo based on the next -number in the AFIP POS, the next button that is visible under :doc:`developer mode -` can be used: +number in the AFIP POS, the next button that is visible under :ref:`developer mode ` +can be used: .. image:: media/argentina_edi_05.png :align: center diff --git a/content/applications/finance/accounting/fiscal_localizations/localizations/colombia.rst b/content/applications/finance/accounting/fiscal_localizations/localizations/colombia.rst index 2b4c2817d..e304be8f6 100644 --- a/content/applications/finance/accounting/fiscal_localizations/localizations/colombia.rst +++ b/content/applications/finance/accounting/fiscal_localizations/localizations/colombia.rst @@ -142,7 +142,7 @@ Journals Once the DIAN has assigned the official sequence and prefix for the electronic invoice resolution, the Sales journals related to your invoice documents need to be updated in Odoo. The sequence can be -accessed using the :doc:`Developer mode `: :menuselection:`Accounting --> +accessed using the :ref:`developer mode `: :menuselection:`Accounting --> Settings --> Configuration Setting --> Journals`. .. image:: media/colombia09.png diff --git a/content/applications/finance/accounting/fiscal_localizations/localizations/france.rst b/content/applications/finance/accounting/fiscal_localizations/localizations/france.rst index 63b2407fb..3633eef74 100644 --- a/content/applications/finance/accounting/fiscal_localizations/localizations/france.rst +++ b/content/applications/finance/accounting/fiscal_localizations/localizations/france.rst @@ -74,7 +74,7 @@ To get the certification just follow the following steps: .. note:: * To install the module in any system created before December 18th 2017, you should update the modules list. - To do so, activate the :doc:`Developer mode `. + To do so, activate the :ref:`developer mode `. Then go to the *Apps* menu and press *Update Modules List* in the top-menu. * In case you run Odoo on-premise, you need to update your installation and restart your server beforehand. @@ -156,8 +156,8 @@ Invoicing and Accounting apps. it will be counted in the very next closing. .. tip:: For test & audit purposes such closings can be manually generated in the - :doc:`Developer mode `. Then go to - :menuselection:`Settings --> Technical --> Automation --> Scheduled Actions`. + :ref:`developer mode `. Then go to :menuselection:`Settings --> + Technical --> Automation --> Scheduled Actions`. Responsibilities diff --git a/content/applications/finance/accounting/fiscal_localizations/localizations/mexico.rst b/content/applications/finance/accounting/fiscal_localizations/localizations/mexico.rst index caa3ca0b8..89516080a 100644 --- a/content/applications/finance/accounting/fiscal_localizations/localizations/mexico.rst +++ b/content/applications/finance/accounting/fiscal_localizations/localizations/mexico.rst @@ -111,7 +111,7 @@ Enabling CFDI Version 3.3 SaaS instance please ask for an upgrade by submitting a ticket to support in https://www.odoo.com/help. -Enable the :doc:`Developer mode `. +Activate the :ref:`developer mode `. Go and look the following technical parameter, on :menuselection:`Settings --> Technical --> Parameters --> System Parameters` @@ -630,7 +630,7 @@ Enabling Explicit errors on the CFDI using the XSD local validator (CFDI 3.3) Frequently you want receive explicit errors from the fields incorrectly set on the xml, those errors are better informed to the user if the check is enable, to enable the Check with xsd feature follow the next steps (with the -:doc:`Developer mode ` enabled). +:ref:`developer mode ` enabled). - Go to :menuselection:`Settings --> Technical --> Actions --> Server Actions` - Look for the Action called "Download XSD files to CFDI" diff --git a/content/applications/finance/accounting/reporting/overview/customize.rst b/content/applications/finance/accounting/reporting/overview/customize.rst index 6aa7cba3b..e27fb6a1d 100644 --- a/content/applications/finance/accounting/reporting/overview/customize.rst +++ b/content/applications/finance/accounting/reporting/overview/customize.rst @@ -14,7 +14,7 @@ Activate the developer mode =========================== In order to have access to the financial report creation interface, the -:doc:`Developer mode ` needs to be activated. +:ref:`developer mode ` needs to be activated. Create your financial report ============================ diff --git a/content/applications/general.rst b/content/applications/general.rst index ea863936f..5745694dd 100644 --- a/content/applications/general.rst +++ b/content/applications/general.rst @@ -1,8 +1,9 @@ +:show-content: + ======= General ======= - .. toctree:: general/odoo_basics @@ -13,6 +14,194 @@ General general/payment_acquirers general/voip general/in_app_purchase - general/developer_mode general/unsplash - general/mobile + +.. _general/users-features: + +Users and Features +================== + +As the administrator of your database, you are responsible for its usage. +This includes the Apps you install as well as the number of users currently +in use. + +Odoo is many things (ERP, CMS, CRM application, e-Commerce backend, etc.) +but it is *not* a smartphone. You should apply caution when adding/removing +features (especially Apps) on your database since this may impact your +subscription amount significantly (or switch you from a free account +to a paying one on our online platform). + +This section contains some information as to how you can manage your Odoo +instances. Before carrying any of these procedures, we **strongly** advise +to test them on a duplicate of your database first. That way, if something goes +wrong, your day-to-day business is not impacted. + +.. note:: You can find guides on how to duplicate your databases both for + :ref:`online ` and :ref:`on premise ` + installations. + +.. note:: If you have questions about the content of this section or if you + encounter an issue while carrying out these procedures, please contact + us through our `support form `__. + + +Deactivating Users +------------------ + +.. note:: Make sure you have sufficient **administrative rights** if + you want to change the status of any of your users. + +In your Odoo instance, click on **Settings**. You will have a section +showing you the active users on your database. Click on **Manage Users.** + ++----------------+----------------+ +| |settings| | |browse_users| | ++----------------+----------------+ + +You'll then see the list of your users. + +.. image:: general/list_users.png + :align: center + +.. note:: The pre-selected filter *Internal Users* shows your paying + users (different from the *Portal Users* which are free). If you + remove this filter, you'll get all your users (the ones you pay for + and the portal ones) + +In your list of users, click on the user you want to deactivate. As soon +as you are on the userform, click on the Action drop down menu, and +then click on Archive. + +.. image:: general/deactivate_user.png + :align: center + + +The user is now deactivated. + +.. danger:: **Never** deactivate the main user (*admin*) + +Uninstalling Apps +----------------- + +.. warning:: Make sure you first test what you are about to do on a + :ref:`duplicate ` of your database before making any + changes (*especially* installing/uninstalling apps). + +In your Odoo instance click on **Settings**; in this app, you will be +able to see how many applications you have installed. Click on **Browse +Apps** to access the list of your installed applications. + ++----------------+----------------+ +| |settings| | |browse_apps| | ++----------------+----------------+ + +In your applications' dashboard, you will see all the icons of your +applications. Click on the application you want to uninstall. Then, on +the form of the application, click on **Uninstall**. + +.. image:: general/uninstall.png + :align: center + +.. danger:: Some applications have dependencies, like Invoicing, eCommerce, + etc. Therefore, the system will give you a warning message to advise + you of what is about to be removed. If you uninstall your application, + all its dependencies will be uninstalled as well (and the data in them + will permanently disappear). If you are sure you still want to uninstall + it, then click **Confirm**. + +Last, after having checked the warning message (if any), click **Confirm**. + +.. image:: general/uninstall_deps.png + :align: center + +You have finished uninstalling your application. + +Good to know +------------ + +* **Uninstalling apps, managing users, etc. is up to you**: no one else can + know if your business flow is broken better than you. If we were to uninstall + applications for you, we would never be able to tell if relevant data had + been removed or if one of your business flow was broken because we *do not + know how you work* and therefore cannot validate these kinds of operations. + +* **Odoo Apps have dependencies**: this means that you may need to install + modules that you do not actively use to access some features of Odoo + you might need. For example, the Website Builder app is needed to be + able to show your customer their Quotes in a web page. Even though you + might not need or use the Website itself, it is needed for the Online + Quotes feature to work properly. + +* **Always test app installation/removal on a duplicate** (or on a + free trial database): that way you can know what other apps may + be required, etc. This will avoid surprises when uninstalling + or when receiving your invoices. + +.. |settings| image:: general/settings_app.png +.. |browse_apps| image:: general/browse_apps.png +.. |browse_users| image:: general/browse_users.png + +.. _developer-mode: + +Activate the developer mode (debug mode) +======================================== + +The developer mode (or debug mode) gives you access to extra and advanced tools. + +Through the Settings application +-------------------------------- + +Go to :menuselection:`Settings --> Activate the developer mode`. + +.. image:: general/settings.png + :align: center + :alt: Overview of the debug options under settings in Odoo + +.. note:: + *Activate the developer mode (with assets)* is used by developers; *Activate the developer mode + (with tests assets)* is used by developers and testers. + +Once activated, the *Deactivate the developer mode* option becomes available. + +Through a browser extension +--------------------------- + +| Go to the settings and extensions of your web browser, and search for *Odoo Debug*. Once the + extension is installed, a new icon will be shown on your toolbar. +| For the *Odoo Debug* extension, a single click enables a normal version of the mode, while a + double click enables it with assets. To deactivate it, use a single click. + +.. image:: general/monkey.png + :align: center + :alt: View of odoo’s debug icon in a chrome’s toolbar + +Through the URL +--------------- + +In the URL add ``?debug=1`` or ``?debug=true`` after *web*. + +.. image:: general/url.png + :align: center + :alt: Overview of an url with the debug mode command added in Odoo + +.. tip:: + Developers: type ``?debug=assets`` and activate the mode with assets. + +Locate the mode tools +--------------------- + +The Developer mode tools can be accessed from the *Open Developer Tools* button, located on the +header of your pages. + +.. image:: general/button_location.png + :align: center + :alt: Overview of a console page and the debug icon being shown in Odoo + +Mobile Push Notifications +========================= + +As of Odoo 12.0, 13.0 or above, there is no more complex configuration to enable push +notifications in the mobile app. + +Simply go to :menuselection:`Settings --> General Settings --> Odoo Cloud Notification (OCN)` +and make sure that **Push Notifications** is checked. diff --git a/content/applications/settings/media/browse_apps.png b/content/applications/general/browse_apps.png similarity index 100% rename from content/applications/settings/media/browse_apps.png rename to content/applications/general/browse_apps.png diff --git a/content/applications/settings/media/browse_users.png b/content/applications/general/browse_users.png similarity index 100% rename from content/applications/settings/media/browse_users.png rename to content/applications/general/browse_users.png diff --git a/content/applications/general/developer_mode/media/button_location.png b/content/applications/general/button_location.png similarity index 100% rename from content/applications/general/developer_mode/media/button_location.png rename to content/applications/general/button_location.png diff --git a/content/applications/settings/media/deactivate_user.png b/content/applications/general/deactivate_user.png old mode 100755 new mode 100644 similarity index 100% rename from content/applications/settings/media/deactivate_user.png rename to content/applications/general/deactivate_user.png diff --git a/content/applications/general/developer_mode.rst b/content/applications/general/developer_mode.rst deleted file mode 100644 index 2a901fa88..000000000 --- a/content/applications/general/developer_mode.rst +++ /dev/null @@ -1,8 +0,0 @@ -============== -Developer Mode -============== - -.. toctree:: - :titlesonly: - - developer_mode/activate \ No newline at end of file diff --git a/content/applications/general/developer_mode/activate.rst b/content/applications/general/developer_mode/activate.rst deleted file mode 100644 index 5f7dd20e1..000000000 --- a/content/applications/general/developer_mode/activate.rst +++ /dev/null @@ -1,54 +0,0 @@ -=================================== -Activate the Developer (Debug) Mode -=================================== - -The Developer or Debug Mode gives you access to extra and advanced tools. - -Through the Settings application --------------------------------- - -Go to :menuselection:`Settings --> Activate the developer mode`. - -.. image:: media/settings.png - :align: center - :alt: Overview of the debug options under settings in Odoo - -.. note:: - *Activate the developer mode (with assets)* is used by developers; *Activate the developer mode - (with tests assets)* is used by developers and testers. - -Once activated, the *Deactivate the developer mode* option becomes available. - -Through a browser extension ---------------------------- - -| Go to the settings and extensions of your web browser, and search for *Odoo Debug*. Once the - extension is installed, a new icon will be shown on your toolbar. -| For the *Odoo Debug* extension, a single click enables a normal version of the mode, while a - double click enables it with assets. To deactivate it, use a single click. - -.. image:: media/monkey.png - :align: center - :alt: View of odoo’s debug icon in a chrome’s toolbar - -Through the URL ---------------- - -In the URL add ``?debug=1`` or ``?debug=true`` after *web*. - -.. image:: media/url.png - :align: center - :alt: Overview of an url with the debug mode command added in Odoo - -.. tip:: - Developers: type ``?debug=assets`` and activate the mode with assets. - -Locate the mode tools ---------------------- - -The Developer mode tools can be accessed from the *Open Developer Tools* button, located on the -header of your pages. - -.. image:: media/button_location.png - :align: center - :alt: Overview of a console page and the debug icon being shown in Odoo diff --git a/content/applications/general/in_app_purchase.rst b/content/applications/general/in_app_purchase.rst index 60549a9f7..33e61eba6 100644 --- a/content/applications/general/in_app_purchase.rst +++ b/content/applications/general/in_app_purchase.rst @@ -24,8 +24,8 @@ IAP accounts Credits to use IAP services are stored on IAP accounts, which are specific to each service and database. By default, IAP accounts are common to all companies, but can be restricted to specific -ones. Activate the :doc:`Developer mode `, then go to -:menuselection:`Technical Settings --> IAP Account`. +ones. Activate the :ref:`developer mode `, then go to :menuselection:`Technical +Settings --> IAP Account`. .. image:: in_app_purchase/image2.png :align: center diff --git a/content/applications/settings/media/list_users.png b/content/applications/general/list_users.png similarity index 100% rename from content/applications/settings/media/list_users.png rename to content/applications/general/list_users.png diff --git a/content/applications/general/mobile.rst b/content/applications/general/mobile.rst deleted file mode 100644 index 2e2747b12..000000000 --- a/content/applications/general/mobile.rst +++ /dev/null @@ -1,13 +0,0 @@ - -====== -Mobile -====== - -Push Notifications -================== - -As of Odoo 12.0, 13.0 or above, there is no more complex configuration to enable push -notifications in the mobile app. - -Simply go to :menuselection:`Settings --> General Settings --> Odoo Cloud Notification (OCN)` -and make sure that **Push Notifications** is checked. diff --git a/content/applications/general/developer_mode/media/monkey.png b/content/applications/general/monkey.png similarity index 100% rename from content/applications/general/developer_mode/media/monkey.png rename to content/applications/general/monkey.png diff --git a/content/applications/general/multi_companies.rst b/content/applications/general/multi_companies.rst index e2403c69a..c7a545c80 100644 --- a/content/applications/general/multi_companies.rst +++ b/content/applications/general/multi_companies.rst @@ -19,9 +19,9 @@ long as both environments are active). :alt: Overview of a new company's form in Odoo .. tip:: - Activate the :doc:`Developer mode ` to choose a *Favicon* - for each of your companies, and easily identify them by the browser tabs. Set your - favicons’ files size to 16x16 or 32x32 pixels. JPG, PNG, GIF, and ICO are extensions accepted. + Activate the :ref:`developer mode ` to choose a *Favicon* for each of your + companies, and easily identify them by the browser tabs. Set your favicons’ files size to 16x16 + or 32x32 pixels. JPG, PNG, GIF, and ICO are extensions accepted. .. image:: multi_companies/favicon.png :align: center diff --git a/content/applications/general/odoo_basics/users.rst b/content/applications/general/odoo_basics/users.rst index 159535ccc..cd77aa086 100644 --- a/content/applications/general/odoo_basics/users.rst +++ b/content/applications/general/odoo_basics/users.rst @@ -39,8 +39,7 @@ the user. The user must click on it to accept the invitation and create a login. `pricing page `_ for more information. -With the :doc:`Developer mode ` activated, *User Types* can -be selected. +With the :ref:`developer mode ` activated, *User Types* can be selected. .. image:: users/user-type.png :align: center @@ -121,8 +120,8 @@ can reaccess your database using your new password. Access Rights in detail ======================= -Activate the :doc:`Developer mode `, then go to -:menuselection:`Settings --> Users & Companies --> Groups`. +Activate the :ref:`developer mode `, then go to :menuselection:`Settings --> Users +& Companies --> Groups`. Groups ------ @@ -203,4 +202,4 @@ the user can have access. .. seealso:: - :doc:`../multi_companies` - - :doc:`../../settings/users_and_features` \ No newline at end of file + - :doc:`../../general` \ No newline at end of file diff --git a/content/applications/general/developer_mode/media/settings.png b/content/applications/general/settings.png similarity index 100% rename from content/applications/general/developer_mode/media/settings.png rename to content/applications/general/settings.png diff --git a/content/applications/settings/media/settings_app.png b/content/applications/general/settings_app.png similarity index 100% rename from content/applications/settings/media/settings_app.png rename to content/applications/general/settings_app.png diff --git a/content/applications/settings/media/uninstall.png b/content/applications/general/uninstall.png similarity index 100% rename from content/applications/settings/media/uninstall.png rename to content/applications/general/uninstall.png diff --git a/content/applications/settings/media/uninstall_deps.png b/content/applications/general/uninstall_deps.png similarity index 100% rename from content/applications/settings/media/uninstall_deps.png rename to content/applications/general/uninstall_deps.png diff --git a/content/applications/general/developer_mode/media/url.png b/content/applications/general/url.png similarity index 100% rename from content/applications/general/developer_mode/media/url.png rename to content/applications/general/url.png diff --git a/content/applications/inventory_and_mrp/inventory/barcode/operations/barcode_nomenclature.rst b/content/applications/inventory_and_mrp/inventory/barcode/operations/barcode_nomenclature.rst index 76ebc72b4..c5bf1dc77 100644 --- a/content/applications/inventory_and_mrp/inventory/barcode/operations/barcode_nomenclature.rst +++ b/content/applications/inventory_and_mrp/inventory/barcode/operations/barcode_nomenclature.rst @@ -14,7 +14,7 @@ Create a Barcode Nomenclature Odoo supports Barcode Nomenclatures, which determine the mapping and interpretation of the encoded information. You can configure your barcode nomenclature being in -:doc:`Developer mode `. +:ref:`developer mode `. To do so, go to :menuselection:`Inventory --> Configuration --> Barcode Nomenclature`. You can create a barcode nomenclature from there, and then add a line to diff --git a/content/applications/inventory_and_mrp/inventory/management/planning/schedulers.rst b/content/applications/inventory_and_mrp/inventory/management/planning/schedulers.rst index 6d9bd92e6..ab2389cab 100644 --- a/content/applications/inventory_and_mrp/inventory/management/planning/schedulers.rst +++ b/content/applications/inventory_and_mrp/inventory/management/planning/schedulers.rst @@ -44,8 +44,7 @@ production orders, deliveries and supplier purchases. Configure and run the scheduler (for advanced users) ---------------------------------------------------- -To use this feature, you have to enable the -:doc:`Developer mode ` mode. +To use this feature, you have to activate the :ref:`developer mode `. Then, go to :menuselection:`Settings --> Technical --> Automation --> Scheduled Actions` and modify the *Run MRP Scheduler Configuration*. There, you can set diff --git a/content/applications/inventory_and_mrp/inventory/management/reporting/inventory_valuation_config.rst b/content/applications/inventory_and_mrp/inventory/management/reporting/inventory_valuation_config.rst index cc65d9706..26e816e16 100644 --- a/content/applications/inventory_and_mrp/inventory/management/reporting/inventory_valuation_config.rst +++ b/content/applications/inventory_and_mrp/inventory/management/reporting/inventory_valuation_config.rst @@ -184,7 +184,7 @@ accounting modes. Usually, based on your country, the correct accounting mode will be chosen by default. If you want to verify your accounting mode, activate -the :doc:`Developer mode ` and open your accounting +the :ref:`developer mode ` and open your accounting settings. Manual Inventory Valuation diff --git a/content/applications/marketing/sms_marketing/overview/integrations_and_template.rst b/content/applications/marketing/sms_marketing/overview/integrations_and_template.rst index 7401e73b7..9be1dbabe 100644 --- a/content/applications/marketing/sms_marketing/overview/integrations_and_template.rst +++ b/content/applications/marketing/sms_marketing/overview/integrations_and_template.rst @@ -47,8 +47,8 @@ all the contacts needed, and under *Action* select *Send SMS*. Set up SMS templates ==================== -To set up *SMS Templates*, activate the :doc:`Developer mode `, -then go to :menuselection:`Technical --> SMS Templates`. +To set up *SMS Templates*, activate the :ref:`developer mode `, then go to +:menuselection:`Technical --> SMS Templates`. .. image:: ./media/sms_marketing17.png :align: center diff --git a/content/applications/marketing/sms_marketing/pricing/pricing_and_faq.rst b/content/applications/marketing/sms_marketing/pricing/pricing_and_faq.rst index 62b38743c..48332a510 100644 --- a/content/applications/marketing/sms_marketing/pricing/pricing_and_faq.rst +++ b/content/applications/marketing/sms_marketing/pricing/pricing_and_faq.rst @@ -99,8 +99,7 @@ More common questions #. **Do I have a history of the sent SMSs?** Yes, the SMS is logged as a note under the chatter of the corresponding record, and a complete - history of the SMSs sent is available on - :doc:`Developer mode ` under + history of the SMSs sent is available on :ref:`developer mode ` under :menuselection:`Technical --> SMS`. diff --git a/content/applications/productivity/discuss/advanced/email_servers.rst b/content/applications/productivity/discuss/advanced/email_servers.rst index 0a04ef33a..06f7dfcfd 100644 --- a/content/applications/productivity/discuss/advanced/email_servers.rst +++ b/content/applications/productivity/discuss/advanced/email_servers.rst @@ -209,7 +209,7 @@ alias in your mail server. .. tip:: All the aliases are customizable in Odoo. Object aliases can be edited from their respective configuration view. To edit catchall and bounce aliases, you first need to activate the - :doc:`Developer mode `. + :ref:`developer mode `. Then go to :menuselection:`Settings --> Technical --> Parameters --> System Parameters` to customize the aliases (*mail.catchall.alias* & * mail.bounce.alias*). @@ -218,7 +218,7 @@ alias in your mail server. :align: center .. note:: By default inbound messages are fetched every 5 minutes in Odoo on-premise. - You can change this value in :doc:`Developer mode `. + You can change this value in :ref:`developer mode `. Go to :menuselection:`Settings --> Technical --> Automation --> Scheduled Actions` and look for *Mail: Fetchmail Service*. @@ -239,11 +239,10 @@ or Sendgrid for mass mailings. A default outgoing email server is already configured. You should not create an alternative one unless you want to use a specific external outgoing email server for technical reasons. -To do this, you should first enable the :doc:`Developer mode -` and then go to :menuselection:`Settings --> Technical ---> Outgoing` e-mail servers. There you have to create two e-mail MTA server settings. One for -transactional e-mails and one for mass mail servers. Be sure to mark the priority of transactional -e-mail servers as low as the mass email servers. +To do this, you should first activate the :ref:`developer mode ` and then go to +:menuselection:`Settings --> Technical --> Outgoing` e-mail servers. There you have to create two +e-mail MTA server settings. One for transactional e-mails and one for mass mail servers. Be sure to +mark the priority of transactional e-mail servers as low as the mass email servers. Now, go to :menuselection:`Email Marketing --> Settings` and enable *Dedicated Server*. With these settings, Odoo uses the server with the lower priority for transactional emails, and the diff --git a/content/applications/productivity/discuss/advanced/email_template.rst b/content/applications/productivity/discuss/advanced/email_template.rst index 993b95a20..63631d34f 100644 --- a/content/applications/productivity/discuss/advanced/email_template.rst +++ b/content/applications/productivity/discuss/advanced/email_template.rst @@ -11,8 +11,8 @@ improving their overall experience with the company. Enable it and understand a few concepts ======================================= -The :doc:`Developer mode ` must be activated. Then, go to -:menuselection:`Settings --> Technical --> Templates`. A view of the existing templates is shown. +The :ref:`developer mode ` must be activated. Then, go to :menuselection:`Settings +--> Technical --> Templates`. A view of the existing templates is shown. .. warning:: **It is highly recommended not to change the content in existing templates unless the user has diff --git a/content/applications/productivity/studio/how_to/reports.rst b/content/applications/productivity/studio/how_to/reports.rst index 0c059e067..bbcc4e378 100644 --- a/content/applications/productivity/studio/how_to/reports.rst +++ b/content/applications/productivity/studio/how_to/reports.rst @@ -50,8 +50,8 @@ added to the *Print* menu list on its respective document form. :align: center :alt: View of an invoice form emphasizing the menu print for Odoo Studio -If activating the :doc:`Developer mode `, additional fields -such as *Class* under *Options*, and *Reload from attachment* under *Report*, become visible. +If activating the :ref:`developer mode `, additional fields such as *Class* under +*Options*, and *Reload from attachment* under *Report*, become visible. - *Class*: add custom CSS classes to the selected element (e.g. Bootstrap classes such as *text-danger*). diff --git a/content/applications/productivity/studio/use_cases/models_fields.rst b/content/applications/productivity/studio/use_cases/models_fields.rst index 8a898e68d..c56aa19fa 100644 --- a/content/applications/productivity/studio/use_cases/models_fields.rst +++ b/content/applications/productivity/studio/use_cases/models_fields.rst @@ -116,7 +116,7 @@ Administrator* or managers. - **Case scenario 5: change the tooltip of a field for all views.** -| Activate the :doc:`Developer mode ` and open Studio. +| Activate the :ref:`developer mode ` and open Studio. | Select the necessary field and, under *Properties*, click on *More* to write your tooltip message on *Field Help*. The tooltip message is the explanatory message shown when the user hovers the field. The message here written is displayed on all views forms where the field is added. diff --git a/content/applications/sales/sales/amazon_connector/manage.rst b/content/applications/sales/sales/amazon_connector/manage.rst index 2094907c0..7a7edfcb1 100644 --- a/content/applications/sales/sales/amazon_connector/manage.rst +++ b/content/applications/sales/sales/amazon_connector/manage.rst @@ -19,16 +19,15 @@ Seller Central and notify the customer. .. note:: To force the synchronization of an order whose status has not changed since the last - synchronization, activate the :doc:`Developer mode `, - navigate to your Amazon account and modify the date under - :menuselection:`Orders Follow-up --> Last Order Sync`. Pick a date anterior to the last status - change of the order that you wish to synchronize and save. + synchronization, activate the :ref:`developer mode `, navigate to your Amazon + account and modify the date under :menuselection:`Orders Follow-up --> Last Order Sync`. Pick a + date anterior to the last status change of the order that you wish to synchronize and save. .. tip:: - To synchronize immediately the orders of your Amazon account switch to - :doc:`Developer mode `, head to your Amazon account and click on - **SYNC ORDERS**. The same can be done with order cancellations and pickings by clicking - on **SYNC CANCELLATIONS** and **SYNC PICKINGS**. + To synchronize immediately the orders of your Amazon account switch to :ref:`developer mode + `, head to your Amazon account and click on **SYNC ORDERS**. The same can be done + with order cancellations and pickings by clicking on **SYNC CANCELLATIONS** and **SYNC + PICKINGS**. Manage deliveries in FBM ======================== diff --git a/content/applications/sales/sales/amazon_connector/setup.rst b/content/applications/sales/sales/amazon_connector/setup.rst index 32f0ea545..2c6059f79 100644 --- a/content/applications/sales/sales/amazon_connector/setup.rst +++ b/content/applications/sales/sales/amazon_connector/setup.rst @@ -97,9 +97,8 @@ code, a default database product **Amazon Sale** is used. The same is done with **Amazon Shipping** and the shipping code. .. note:: - To modify the default products, activate the - :doc:`Developer mode ` and navigate to - :menuselection:`Sales --> Configuration --> Settings --> Connectors --> Amazon Sync --> + To modify the default products, activate the :ref:`developer mode ` and navigate + to :menuselection:`Sales --> Configuration --> Settings --> Connectors --> Amazon Sync --> Default Products`. Configure taxes of products @@ -130,8 +129,7 @@ marketplaces. `_. The marketplace must belong to the same region as that of your seller account. -To add a new marketplace, you must first enable :doc:`Developer mode -`. +To add a new marketplace, you must first activate the :ref:`developer mode `. Once that is done, go to :menuselection:`Sales --> Configuration --> Settings --> Connectors --> Amazon Sync --> Amazon Marketplaces`. diff --git a/content/applications/sales/sales/amazon_connector/update.rst b/content/applications/sales/sales/amazon_connector/update.rst index 9362ac74d..cedb42471 100644 --- a/content/applications/sales/sales/amazon_connector/update.rst +++ b/content/applications/sales/sales/amazon_connector/update.rst @@ -41,8 +41,8 @@ Update the list of available modules New modules must be *discovered* by your Odoo instance to be available in the **Apps** menu. -To do so, activate the :doc:`Developer Mode `, and go to -:menuselection:`Apps --> Update Apps List`. A wizard will ask for confirmation. +To do so, activate the :ref:`developer mode `, and go to :menuselection:`Apps --> +Update Apps List`. A wizard will ask for confirmation. Install the Amazon/Authentication Patch ======================================= diff --git a/content/applications/sales/sales/ebay_connector/setup.rst b/content/applications/sales/sales/ebay_connector/setup.rst index a15e77c2e..64cc0dd75 100644 --- a/content/applications/sales/sales/ebay_connector/setup.rst +++ b/content/applications/sales/sales/ebay_connector/setup.rst @@ -48,7 +48,7 @@ parallel in existing installations. To switch to the new synchronization mechanism: -#. Enable the :doc:`Developer mode `. +#. Activate the :ref:`developer mode `. #. Go to :menuselection:`Settings --> Technical --> Scheduled Actions` #. Archive the old synchronization actions (both are named *Ebay: update product status*) #. Activate the new synchronization actions (*Ebay: get new orders* which runs every 15min by default and *Ebay: synchronise stock (for 'get new orders' synchronisation)* which runs once a day per default) diff --git a/content/applications/services/planning/overview/duplicate_a_planning.rst b/content/applications/services/planning/overview/duplicate_a_planning.rst index 4caa02fb6..34082e930 100644 --- a/content/applications/services/planning/overview/duplicate_a_planning.rst +++ b/content/applications/services/planning/overview/duplicate_a_planning.rst @@ -28,7 +28,7 @@ of re-planning it. .. note:: Repeated shifts are generated for the next six months. A modification is possible in - :doc:`Developer mode `, from *Settings*. + :ref:`developer mode `, from *Settings*. .. image:: media/rate_shift_generation.png :align: center diff --git a/content/applications/services/project/advanced/advanced_projects.rst b/content/applications/services/project/advanced/advanced_projects.rst index 9a61cd0e4..5868e38a4 100644 --- a/content/applications/services/project/advanced/advanced_projects.rst +++ b/content/applications/services/project/advanced/advanced_projects.rst @@ -100,9 +100,9 @@ Share stages across projects | In order to have a clean Kanban view that works across projects, and to avoid duplicates, delineate specific stages for different projects. -| :doc:`Activate the Developer mode ` then go to - :menuselection:`Project --> Configuration --> Stages`. Choose the respective one and add - the projects among which you would like to share stages. +| Activate the :ref:`developer mode ` then go to :menuselection:`Project --> + Configuration --> Stages`. Choose the respective one and add the projects among which you would + like to share stages. .. image:: media/share_stages.png :align: center diff --git a/content/applications/services/project/advanced/profitability.rst b/content/applications/services/project/advanced/profitability.rst index b4bb60fbe..da7cc63ec 100644 --- a/content/applications/services/project/advanced/profitability.rst +++ b/content/applications/services/project/advanced/profitability.rst @@ -29,9 +29,9 @@ by people according to the billable hours recorded, and even a timesheet table. If you do not have the Timesheets application installed ------------------------------------------------------- -| Activate the :doc:`Developer mode `. Then go to - *Manager Users* and enable *Analytic Accounting*. Now, go to :menuselection:`Project --> - Configuration --> Projects` and specify an *Analytic Account* under the needed project. +| Activate the :ref:`developer mode `. Then go to *Manager Users* and enable + *Analytic Accounting*. Now, go to :menuselection:`Project --> Configuration --> Projects` and + specify an *Analytic Account* under the needed project. | A *Profitability* menu to the costs and revenues of this analytic account is directly available in the Kanban view. diff --git a/content/applications/services/timesheets/overview/time_off.rst b/content/applications/services/timesheets/overview/time_off.rst index cc7884aae..e47fa9e15 100644 --- a/content/applications/services/timesheets/overview/time_off.rst +++ b/content/applications/services/timesheets/overview/time_off.rst @@ -6,8 +6,8 @@ Odoo automatically timesheets on project/tasks upon time off requests. This allo overall control over the validation of timesheets, as it does not leave place for forgetfulness and questions after hours that have not been timesheeted by the employee. -Activate the :doc:`Developer mode `, go to *Timesheets*, -and change the *Project* and *Task* set by default, if you like. +Activate the :ref:`developer mode `, go to *Timesheets*, and change the *Project* +and *Task* set by default, if you like. .. image:: media/record_time_off.png :align: center diff --git a/content/applications/settings.rst b/content/applications/settings.rst deleted file mode 100644 index 27a9c4970..000000000 --- a/content/applications/settings.rst +++ /dev/null @@ -1,8 +0,0 @@ -======== -Settings -======== - - -.. toctree:: - - settings/users_and_features diff --git a/content/applications/settings/users_and_features.rst b/content/applications/settings/users_and_features.rst deleted file mode 100644 index b79b6a828..000000000 --- a/content/applications/settings/users_and_features.rst +++ /dev/null @@ -1,126 +0,0 @@ - -.. _db_management/documentation: - -================== -Users and Features -================== - -As the administrator of your database, you are responsible for its usage. -This includes the Apps you install as well as the number of users currently -in use. - -Odoo is many things (ERP, CMS, CRM application, e-Commerce backend, etc.) -but it is *not* a smartphone. You should apply caution when adding/removing -features (especially Apps) on your database since this may impact your -subscription amount significantly (or switch you from a free account -to a paying one on our online platform). - -This page contains some information as to how you can manage your Odoo -instances. Before carrying any of these procedures, we **strongly** advise -to test them on a duplicate of your database first. That way, if something goes -wrong, your day-to-day business is not impacted. - -.. note:: You can find guides on how to duplicate your databases both for - :ref:`online ` and :ref:`on premise ` - installations. - -.. note:: If you have questions about the content of this page or if you - encounter an issue while carrying out these procedures, please contact - us through our `support form `__. - - -Deactivating Users -================== - -.. note:: Make sure you have sufficient **administrative rights** if - you want to change the status of any of your users. - -In your Odoo instance, click on **Settings**. You will have a section -showing you the active users on your database. Click on **Manage Users.** - -+----------------+----------------+ -| |settings| | |browse_users| | -+----------------+----------------+ - -You'll then see the list of your users. - -.. image:: media/list_users.png - :align: center - -.. note:: The pre-selected filter *Internal Users* shows your paying - users (different from the *Portal Users* which are free). If you - remove this filter, you'll get all your users (the ones you pay for - and the portal ones) - -In your list of users, click on the user you want to deactivate. As soon -as you are on the userform, click on the Action drop down menu, and -then click on Archive. - -.. image:: media/deactivate_user.png - :align: center - - -The user is now deactivated. - -.. danger:: **Never** deactivate the main user (*admin*) - -Uninstalling Apps -================= - -.. warning:: Make sure you first test what you are about to do on a - :ref:`duplicate ` of your database before making any - changes (*especially* installing/uninstalling apps). - -In your Odoo instance click on **Settings**; in this app, you will be -able to see how many applications you have installed. Click on **Browse -Apps** to access the list of your installed applications. - -+----------------+----------------+ -| |settings| | |browse_apps| | -+----------------+----------------+ - -In your applications' dashboard, you will see all the icons of your -applications. Click on the application you want to uninstall. Then, on -the form of the application, click on **Uninstall**. - -.. image:: media/uninstall.png - :align: center - -.. danger:: Some applications have dependencies, like Invoicing, eCommerce, - etc. Therefore, the system will give you a warning message to advise - you of what is about to be removed. If you uninstall your application, - all its dependencies will be uninstalled as well (and the data in them - will permanently disappear). If you are sure you still want to uninstall - it, then click **Confirm**. - -Last, after having checked the warning message (if any), click **Confirm**. - -.. image:: media/uninstall_deps.png - :align: center - -You have finished uninstalling your application. - -Good to know -============ - -* **Uninstalling apps, managing users, etc. is up to you**: no one else can - know if your business flow is broken better than you. If we were to uninstall - applications for you, we would never be able to tell if relevant data had - been removed or if one of your business flow was broken because we *do not - know how you work* and therefore cannot validate these kinds of operations. - -* **Odoo Apps have dependencies**: this means that you may need to install - modules that you do not actively use to access some features of Odoo - you might need. For example, the Website Builder app is needed to be - able to show your customer their Quotes in a web page. Even though you - might not need or use the Website itself, it is needed for the Online - Quotes feature to work properly. - -* **Always test app installation/removal on a duplicate** (or on a - free trial database): that way you can know what other apps may - be required, etc. This will avoid surprises when uninstalling - or when receiving your invoices. - -.. |settings| image:: media/settings_app.png -.. |browse_apps| image:: media/browse_apps.png -.. |browse_users| image:: media/browse_users.png diff --git a/content/applications/websites/website/optimize/seo.rst b/content/applications/websites/website/optimize/seo.rst index e11f26cf4..4b839e359 100644 --- a/content/applications/websites/website/optimize/seo.rst +++ b/content/applications/websites/website/optimize/seo.rst @@ -480,10 +480,9 @@ page. As these files are shared across all pages, further clicks by the same visitor will not load any other Javascript resource. .. note:: - If you work on :doc:`Developer mode `, the CSS and - Javascript are neither concatenated, nor minified. Thus, it's much slower. But it allows you to - easily debug with the Chrome debugger as CSS and Javascript resources are not transformed from - their original versions. + If you work on :ref:`developer mode `, the CSS and Javascript are neither + concatenated, nor minified. Thus, it's much slower. But it allows you to easily debug with the + Chrome debugger as CSS and Javascript resources are not transformed from their original versions. CDN --- @@ -638,7 +637,7 @@ It means that all robots are allowed to index your website and there is no other indexing rule than specified in the sitemap to be found at following address. -You can customize the file *robots* in -:doc:`Developer mode ` from *Settings --> Technical --> -User Interface --> Views* (exclude robots, exclude some pages, redirect to a custom Sitemap). -Make the Model Data of the view *Non Updatable* to not reset the file after system upgrades. +You can customize the file *robots* in :ref:`developer mode ` from *Settings --> +Technical --> User Interface --> Views* (exclude robots, exclude some pages, redirect to a custom +Sitemap). Make the Model Data of the view *Non Updatable* to not reset the file after system +upgrades. diff --git a/redirects.txt b/redirects.txt index 982878556..671319b44 100644 --- a/redirects.txt +++ b/redirects.txt @@ -205,5 +205,8 @@ applications/general/unsplash/unsplash_application_id.rst applications/general/u applications/general/base_import/import_faq.rst applications/general/export_import_data.rst # base_import/import_faq -> odoo_basics/import_data applications/general/base_import/adapt_template.rst applications/general/export_import_data.rst # base_import/adapt_template -> odoo_basics/import_data content/applications/general/odoo_basics/export-data.rst applications/general/export_import_data.rst # odoo_basics/export-data -> export_import_data +applications/settings/users_and_features.rst applications/general.rst # settings/users_and_features -> general +applications/general/mobile.rst applications/general.rst # general/mobile -> general +applications/general/developer_mode/activate.rst applications/general.rst # developer_mode/activate -> general applications/finance/sign/overview/signature_validity.rst applications/finance/sign.rst #sign/overview/signature_validity -> sign/* From 400b3f52b7425efbbd218967bacec344dfbef206 Mon Sep 17 00:00:00 2001 From: Jonathan Castillo Date: Fri, 28 May 2021 14:26:18 +0200 Subject: [PATCH 12/21] [MOV] general: renames "odoo_basics" into "users" + split content This commit is part of a larger work to improve the documentation's structure. The toctree structure used to add levels to create categories and make the structure visually more understandable. With the new version of the documentation, plenty of these categories are now redundant. Since other docs were moved away from the section "basics" with previous commits, this category is renamed "users settings" This commit: - renames "basics" into "users settings" - moves the content from "odoo_basics/users" to "users" - it moves the content about "access rights" to a child doc task-2535899 --- content/applications/general.rst | 2 +- .../applications/general/multi_companies.rst | 2 +- content/applications/general/odoo_basics.rst | 9 -- .../general/{odoo_basics => }/users.rst | 99 ++++-------------- .../general/users/access_rights.rst | 67 ++++++++++++ .../access_rights}/groups-access-rights.png | Bin .../access_rights}/groups-inherited.png | Bin .../access_rights}/groups-menus.png | Bin .../access_rights}/groups-record-rules.png | Bin .../access_rights}/groups-users.png | Bin .../users/change-password.png | Bin .../users/invitation-email.png | Bin .../language.rst} | 14 +-- .../language}/choose_language01.png | Bin .../language}/choose_language02.png | Bin .../language}/choose_language03.png | Bin .../language}/choose_language04.png | Bin .../{odoo_basics => }/users/manage-users.png | Bin .../users/multi-companies.png | Bin .../{odoo_basics/media => users}/new_user.png | Bin .../users/password-email.png | Bin .../users/password-reset-login.png | Bin .../{odoo_basics => }/users/user-type.png | Bin .../productivity/studio/how_to/reports.rst | 8 +- .../helpdesk/overview/getting_started.rst | 2 +- redirects.txt | 2 + 26 files changed, 105 insertions(+), 100 deletions(-) delete mode 100644 content/applications/general/odoo_basics.rst rename content/applications/general/{odoo_basics => }/users.rst (57%) create mode 100644 content/applications/general/users/access_rights.rst rename content/applications/general/{odoo_basics/users => users/access_rights}/groups-access-rights.png (100%) rename content/applications/general/{odoo_basics/users => users/access_rights}/groups-inherited.png (100%) rename content/applications/general/{odoo_basics/users => users/access_rights}/groups-menus.png (100%) rename content/applications/general/{odoo_basics/users => users/access_rights}/groups-record-rules.png (100%) rename content/applications/general/{odoo_basics/users => users/access_rights}/groups-users.png (100%) rename content/applications/general/{odoo_basics => }/users/change-password.png (100%) rename content/applications/general/{odoo_basics => }/users/invitation-email.png (100%) rename content/applications/general/{odoo_basics/choose_language.rst => users/language.rst} (86%) rename content/applications/general/{odoo_basics/media => users/language}/choose_language01.png (100%) rename content/applications/general/{odoo_basics/media => users/language}/choose_language02.png (100%) rename content/applications/general/{odoo_basics/media => users/language}/choose_language03.png (100%) rename content/applications/general/{odoo_basics/media => users/language}/choose_language04.png (100%) rename content/applications/general/{odoo_basics => }/users/manage-users.png (100%) rename content/applications/general/{odoo_basics => }/users/multi-companies.png (100%) rename content/applications/general/{odoo_basics/media => users}/new_user.png (100%) rename content/applications/general/{odoo_basics => }/users/password-email.png (100%) rename content/applications/general/{odoo_basics => }/users/password-reset-login.png (100%) rename content/applications/general/{odoo_basics => }/users/user-type.png (100%) diff --git a/content/applications/general.rst b/content/applications/general.rst index 5745694dd..08c594727 100644 --- a/content/applications/general.rst +++ b/content/applications/general.rst @@ -6,7 +6,7 @@ General .. toctree:: - general/odoo_basics + general/users general/export_import_data general/multi_companies general/auth diff --git a/content/applications/general/multi_companies.rst b/content/applications/general/multi_companies.rst index c7a545c80..7d86c1e9b 100644 --- a/content/applications/general/multi_companies.rst +++ b/content/applications/general/multi_companies.rst @@ -50,7 +50,7 @@ company only. To do so, on their forms, choose between: Employees' access ================= -Once companies are created, manage your employees' :doc:`Access Rights ` +Once companies are created, manage your employees' :doc:`Access Rights ` for *Multi Companies*. .. image:: multi_companies/access_rights_multi_companies.png diff --git a/content/applications/general/odoo_basics.rst b/content/applications/general/odoo_basics.rst deleted file mode 100644 index 873685fc3..000000000 --- a/content/applications/general/odoo_basics.rst +++ /dev/null @@ -1,9 +0,0 @@ -====== -Basics -====== - -.. toctree:: - :titlesonly: - - odoo_basics/choose_language - odoo_basics/users \ No newline at end of file diff --git a/content/applications/general/odoo_basics/users.rst b/content/applications/general/users.rst similarity index 57% rename from content/applications/general/odoo_basics/users.rst rename to content/applications/general/users.rst index cd77aa086..877fae188 100644 --- a/content/applications/general/odoo_basics/users.rst +++ b/content/applications/general/users.rst @@ -1,12 +1,24 @@ -======================= -Users and Access Rights -======================= +:show-content: + +============== +Users settings +============== + +.. toctree:: + :titlesonly: + + users/language + users/access_rights Odoo defines a *user* as someone who has access to a database to perform daily tasks. You can add as many users as you need and, in order to restrict the type of information each user can access, rules can be applied. Users and access rights can be added and changed at any point. -.. _general/odoo_basics/add_individual_user: +.. seealso:: + - :doc:`users/language` + - :doc:`users/access_rights` + +.. _users/add-individual: Add individual users ==================== @@ -19,11 +31,11 @@ Go to :menuselection:`Settings --> Manage Users` and click on *Create*. :alt: View of the settings page emphasizing the manage users field in Odoo | Fill in the form with the needed information. Under the tab - :ref:`Access Rights ` choose the group within - each application the user can have access to. + :doc:`Access Rights ` choose the group within each application the user can + have access to. | The list of applications shown is based on the applications installed on the database. -.. image:: media/new_user.png +.. image:: users/new_user.png :align: center :alt: View of a user’s form emphasizing the access rights tab in Odoo @@ -115,74 +127,7 @@ Enter a new password and confirm by clicking on *Change Password*. Click on *Change Password* one more time. You are then redirected to an Odoo login page where you can reaccess your database using your new password. -.. _general/odoo_basics/users/access_rights: - -Access Rights in detail -======================= - -Activate the :ref:`developer mode `, then go to :menuselection:`Settings --> Users -& Companies --> Groups`. - -Groups ------- - -| When choosing the groups the user can have access under - :ref:`Access Rights `, details of the rules and - inheritances of that group are not shown, so this is when the menu *Groups* comes along. *Groups* - are created to define rules to models within an application. -| Under *Users*, have a list of the current ones. The ones with administrative rights are shown - in black. - -.. image:: users/groups-users.png - :align: center - :alt: View of a group’s form emphasizing the tab users in Odoo - -*Inherited* means that users added to this application group are automatically added to the -following ones. In the example below, users who have access to the group *Administrator* of *Sales* -also have access to *Website/Restricted Editor* and *Sales/User: All Documents*. - -.. image:: users/groups-inherited.png - :align: center - :height: 330 - :alt: View of a group’s form emphasizing the tab inherited in Odoo - -.. important:: - Remember to always test the settings being changed in order to ensure that they are being applied - to the needed and right users. - -The *Menus* tab is where you define which menus (models) the user can have access to. - -.. image:: users/groups-menus.png - :align: center - :height: 330 - :alt: View of a group’s form emphasizing the tab menus in Odoo - -*Access Rights* rules are the first level of rights. The field is composed of the object name, which -is the technical name given to a model. For each model, enable the following options as appropriate: - -- *Read*: the values of that object can be only seen by the user. -- *Write*: the values of that object can be edited by the user. -- *Create*: values for that object can be created by the user. -- *Delete*: the values of that object can be deleted by the user. - -.. image:: users/groups-access-rights.png - :align: center - :alt: View of a group’s form emphasizing the tab access rights in Odoo - -| As a second layer of editing and visibility rules, *Record Rules* can be formed. They overwrite, - or refine, the *Access Rights*. -| A record rule is written using a *Domain*. Domains are conditions used to filter or searching - data. Therefore, a domain expression is a list of conditions. For each rule, choose among the - following options: *Read*, *Write*, *Create* and *Delete* values. - -.. image:: users/groups-record-rules.png - :align: center - :alt: View of a group’s form emphasizing the tab record rules in Odoo - -.. important:: - Making changes in access rights can have a big impact on the database. For this reason, we - recommend you to contact your Odoo Business Analyst or our Support Team, unless you have - knowledge about Domains in Odoo. +.. _users/multi-companies: Multi Companies =============== @@ -201,5 +146,5 @@ the user can have access. :alt: View of a user’s form emphasizing the multi companies field in Odoo .. seealso:: - - :doc:`../multi_companies` - - :doc:`../../general` \ No newline at end of file + - :doc:`multi_companies` + - :doc:`../general` \ No newline at end of file diff --git a/content/applications/general/users/access_rights.rst b/content/applications/general/users/access_rights.rst new file mode 100644 index 000000000..8439f24c5 --- /dev/null +++ b/content/applications/general/users/access_rights.rst @@ -0,0 +1,67 @@ +============= +Access Rights +============= + +Activate the :ref:`developer mode `, then go to :menuselection:`Settings --> Users & +Companies --> Groups`. + +Groups +====== + +| When choosing the groups the user can have access under + :ref:`Access Rights `, details of the rules and inheritances of that group + are not shown, so this is when the menu *Groups* comes along. *Groups* are created to define rules + to models within an application. +| Under *Users*, have a list of the current ones. The ones with administrative rights are shown + in black. + +.. image:: access_rights/groups-users.png + :align: center + :alt: View of a group’s form emphasizing the tab users in Odoo + +*Inherited* means that users added to this application group are automatically added to the +following ones. In the example below, users who have access to the group *Administrator* of *Sales* +also have access to *Website/Restricted Editor* and *Sales/User: All Documents*. + +.. image:: access_rights/groups-inherited.png + :align: center + :height: 330 + :alt: View of a group’s form emphasizing the tab inherited in Odoo + +.. important:: + Remember to always test the settings being changed in order to ensure that they are being applied + to the needed and right users. + +The *Menus* tab is where you define which menus (models) the user can have access to. + +.. image:: access_rights/groups-menus.png + :align: center + :height: 330 + :alt: View of a group’s form emphasizing the tab menus in Odoo + +*Access Rights* rules are the first level of rights. The field is composed of the object name, which +is the technical name given to a model. For each model, enable the following options as appropriate: + +- *Read*: the values of that object can be only seen by the user. +- *Write*: the values of that object can be edited by the user. +- *Create*: values for that object can be created by the user. +- *Delete*: the values of that object can be deleted by the user. + +.. image:: access_rights/groups-access-rights.png + :align: center + :alt: View of a group’s form emphasizing the tab access rights in Odoo + +| As a second layer of editing and visibility rules, *Record Rules* can be formed. They overwrite, + or refine, the *Access Rights*. +| A record rule is written using a *Domain*. Domains are conditions used to filter or searching + data. Therefore, a domain expression is a list of conditions. For each rule, choose among the + following options: *Read*, *Write*, *Create* and *Delete* values. + +.. image:: access_rights/groups-record-rules.png + :align: center + :alt: View of a group’s form emphasizing the tab record rules in Odoo + +.. important:: + Making changes in access rights can have a big impact on the database. For this reason, we + recommend you to contact your Odoo Business Analyst or our Support Team, unless you have + knowledge about Domains in Odoo. \ No newline at end of file diff --git a/content/applications/general/odoo_basics/users/groups-access-rights.png b/content/applications/general/users/access_rights/groups-access-rights.png similarity index 100% rename from content/applications/general/odoo_basics/users/groups-access-rights.png rename to content/applications/general/users/access_rights/groups-access-rights.png diff --git a/content/applications/general/odoo_basics/users/groups-inherited.png b/content/applications/general/users/access_rights/groups-inherited.png similarity index 100% rename from content/applications/general/odoo_basics/users/groups-inherited.png rename to content/applications/general/users/access_rights/groups-inherited.png diff --git a/content/applications/general/odoo_basics/users/groups-menus.png b/content/applications/general/users/access_rights/groups-menus.png similarity index 100% rename from content/applications/general/odoo_basics/users/groups-menus.png rename to content/applications/general/users/access_rights/groups-menus.png diff --git a/content/applications/general/odoo_basics/users/groups-record-rules.png b/content/applications/general/users/access_rights/groups-record-rules.png similarity index 100% rename from content/applications/general/odoo_basics/users/groups-record-rules.png rename to content/applications/general/users/access_rights/groups-record-rules.png diff --git a/content/applications/general/odoo_basics/users/groups-users.png b/content/applications/general/users/access_rights/groups-users.png similarity index 100% rename from content/applications/general/odoo_basics/users/groups-users.png rename to content/applications/general/users/access_rights/groups-users.png diff --git a/content/applications/general/odoo_basics/users/change-password.png b/content/applications/general/users/change-password.png similarity index 100% rename from content/applications/general/odoo_basics/users/change-password.png rename to content/applications/general/users/change-password.png diff --git a/content/applications/general/odoo_basics/users/invitation-email.png b/content/applications/general/users/invitation-email.png similarity index 100% rename from content/applications/general/odoo_basics/users/invitation-email.png rename to content/applications/general/users/invitation-email.png diff --git a/content/applications/general/odoo_basics/choose_language.rst b/content/applications/general/users/language.rst similarity index 86% rename from content/applications/general/odoo_basics/choose_language.rst rename to content/applications/general/users/language.rst index bb86d2b94..27572b609 100644 --- a/content/applications/general/odoo_basics/choose_language.rst +++ b/content/applications/general/users/language.rst @@ -1,6 +1,6 @@ -================================ -Manage Odoo in your own language -================================ +=============== +Change language +=============== Odoo provides you with the option to manage Odoo in different languages, and each user can use Odoo in his own language . @@ -15,7 +15,7 @@ From the general dashboard click on the **Settings** app; on the top left of the page select :menuselection:`Translations --> Load a Translation`, select a language to install and click on **LOAD.** -.. image:: media/choose_language01.png +.. image:: language/choose_language01.png :align: center .. note:: @@ -30,13 +30,13 @@ You can change the language to the installed language by going to the drop-down menu at the top right side of the screen, choose **Preferences**. -.. image:: media/choose_language02.png +.. image:: language/choose_language02.png :align: center Then change the Language setting to your installed language and click **SAVE.** -.. image:: media/choose_language03.png +.. image:: language/choose_language03.png :align: center Open a new menu to view the changes. @@ -54,7 +54,7 @@ user and click on **Edit** in the top left corner. Under Preferences you can change the Language to any previously installed language and click **SAVE.** -.. image:: media/choose_language04.png +.. image:: language/choose_language04.png :align: center .. seealso:: diff --git a/content/applications/general/odoo_basics/media/choose_language01.png b/content/applications/general/users/language/choose_language01.png similarity index 100% rename from content/applications/general/odoo_basics/media/choose_language01.png rename to content/applications/general/users/language/choose_language01.png diff --git a/content/applications/general/odoo_basics/media/choose_language02.png b/content/applications/general/users/language/choose_language02.png similarity index 100% rename from content/applications/general/odoo_basics/media/choose_language02.png rename to content/applications/general/users/language/choose_language02.png diff --git a/content/applications/general/odoo_basics/media/choose_language03.png b/content/applications/general/users/language/choose_language03.png similarity index 100% rename from content/applications/general/odoo_basics/media/choose_language03.png rename to content/applications/general/users/language/choose_language03.png diff --git a/content/applications/general/odoo_basics/media/choose_language04.png b/content/applications/general/users/language/choose_language04.png similarity index 100% rename from content/applications/general/odoo_basics/media/choose_language04.png rename to content/applications/general/users/language/choose_language04.png diff --git a/content/applications/general/odoo_basics/users/manage-users.png b/content/applications/general/users/manage-users.png similarity index 100% rename from content/applications/general/odoo_basics/users/manage-users.png rename to content/applications/general/users/manage-users.png diff --git a/content/applications/general/odoo_basics/users/multi-companies.png b/content/applications/general/users/multi-companies.png similarity index 100% rename from content/applications/general/odoo_basics/users/multi-companies.png rename to content/applications/general/users/multi-companies.png diff --git a/content/applications/general/odoo_basics/media/new_user.png b/content/applications/general/users/new_user.png similarity index 100% rename from content/applications/general/odoo_basics/media/new_user.png rename to content/applications/general/users/new_user.png diff --git a/content/applications/general/odoo_basics/users/password-email.png b/content/applications/general/users/password-email.png similarity index 100% rename from content/applications/general/odoo_basics/users/password-email.png rename to content/applications/general/users/password-email.png diff --git a/content/applications/general/odoo_basics/users/password-reset-login.png b/content/applications/general/users/password-reset-login.png similarity index 100% rename from content/applications/general/odoo_basics/users/password-reset-login.png rename to content/applications/general/users/password-reset-login.png diff --git a/content/applications/general/odoo_basics/users/user-type.png b/content/applications/general/users/user-type.png similarity index 100% rename from content/applications/general/odoo_basics/users/user-type.png rename to content/applications/general/users/user-type.png diff --git a/content/applications/productivity/studio/how_to/reports.rst b/content/applications/productivity/studio/how_to/reports.rst index bbcc4e378..fa98c3f24 100644 --- a/content/applications/productivity/studio/how_to/reports.rst +++ b/content/applications/productivity/studio/how_to/reports.rst @@ -34,10 +34,10 @@ them. Fields with related objects have their directives shown on *Field Expressi | Under **Visible if**, define the rule(s) to set visibility conditions to fields. | Example: if choosing to display a product image, you could set a visibility rule to only display the ones that are *set* in the product form, avoiding having a plain icon when they are not set. -| **Visible for** is used to set which :doc:`groups ` - can have access to specific elements in the report. **Limit visibility to groups**, under - *Report*, sets the visibility of the report to specifics groups, meaning that users belonging to - other groups do not see the same final document. +| **Visible for** is used to set which :doc:`groups ` can have access + to specific elements in the report. **Limit visibility to groups**, under *Report*, sets the + visibility of the report to specifics groups, meaning that users belonging to other groups do not + see the same final document. .. image:: media/reports/limit_visibility.png :align: center diff --git a/content/applications/services/helpdesk/overview/getting_started.rst b/content/applications/services/helpdesk/overview/getting_started.rst index e968a409b..7888ff5dc 100644 --- a/content/applications/services/helpdesk/overview/getting_started.rst +++ b/content/applications/services/helpdesk/overview/getting_started.rst @@ -61,4 +61,4 @@ or use the stage. :alt: View of a team’s kanban view in Odoo Helpdesk .. seealso:: - - :doc:`/applications/general/odoo_basics/users` + - :doc:`/applications/general/users` diff --git a/redirects.txt b/redirects.txt index 671319b44..d7efb0053 100644 --- a/redirects.txt +++ b/redirects.txt @@ -208,5 +208,7 @@ content/applications/general/odoo_basics/export-data.rst applications/general/ex applications/settings/users_and_features.rst applications/general.rst # settings/users_and_features -> general applications/general/mobile.rst applications/general.rst # general/mobile -> general applications/general/developer_mode/activate.rst applications/general.rst # developer_mode/activate -> general +applications/general/odoo_basics/users.rst applications/general/users.rst # odoo_basics/users -> users +applications/general/odoo_basics/choose_language.rst applications/general/users/language.rst # odoo_basics/choose_language -> users/language applications/finance/sign/overview/signature_validity.rst applications/finance/sign.rst #sign/overview/signature_validity -> sign/* From 2591ddc6d249b57e594d9d8a2e6b299d070ee867 Mon Sep 17 00:00:00 2001 From: "Antoine Vandevenne (anv)" Date: Fri, 4 Jun 2021 16:24:58 +0200 Subject: [PATCH 13/21] [FIX] odoo_theme: fix crash on menu loading introduced with 675f7bc8 --- extensions/odoo_theme/static/js/menu.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/extensions/odoo_theme/static/js/menu.js b/extensions/odoo_theme/static/js/menu.js index cc56dbd72..3bd428037 100644 --- a/extensions/odoo_theme/static/js/menu.js +++ b/extensions/odoo_theme/static/js/menu.js @@ -43,7 +43,9 @@ lastTocEntry = element; } }) - deepestTocEntries.push(lastTocEntry); // The last TOC entry is the deepest of its branch + if (lastTocEntry) { + deepestTocEntries.push(lastTocEntry); // The last TOC entry is the deepest of its branch + } deepestTocEntries.forEach(deepestTocEntry => { const childTocEntryList = deepestTocEntry.querySelector('ul'); if (childTocEntryList) { From 49baf6b4d7cbdd27286fe9124b1b916cf5c8c505 Mon Sep 17 00:00:00 2001 From: Elisabeth Dickinson Date: Fri, 4 Jun 2021 17:27:11 +0200 Subject: [PATCH 14/21] [IMP] odoo_theme: fix layout on esoteric screens --- extensions/odoo_theme/layout.html | 2 +- .../odoo_theme/static/scss/_variables.scss | 10 +- extensions/odoo_theme/static/style.scss | 182 +++++++++--------- 3 files changed, 105 insertions(+), 89 deletions(-) diff --git a/extensions/odoo_theme/layout.html b/extensions/odoo_theme/layout.html index c0ccb1a51..b231697ad 100644 --- a/extensions/odoo_theme/layout.html +++ b/extensions/odoo_theme/layout.html @@ -64,7 +64,7 @@
          {%- include "layout_templates/header.html" %} -