diff --git a/Makefile b/Makefile index 236e75932..829c29461 100644 --- a/Makefile +++ b/Makefile @@ -10,7 +10,7 @@ LESSOPTS = # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed; then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively, you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) endif # Internal variables. @@ -27,15 +27,17 @@ _extensions/odoo/static/style.css: $(lessfiles) .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext +# Displays list of commands help: @echo "Please use \`make ' where is one of" + @echo " clean to delete the build" @echo " html to make standalone HTML files" @echo " i18nhtml to make standalone translated HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @echo " pickle to make pickle files" @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" + @echo " htmlhelp to make HTML files and an HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " devhelp to make HTML files and a Devhelp project" @echo " epub to make an epub" @@ -53,9 +55,11 @@ help: @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" +# Deletes the build clean: rm -rf $(BUILDDIR)/* +# These commands are used to create files or run tests html: _extensions/odoo/static/style.css $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @@ -79,23 +83,23 @@ singlehtml: pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo - @echo "Build finished; now you can process the pickle files." + @echo "Build finished. Now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo - @echo "Build finished; now you can process the JSON files." + @echo "Build finished. Now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ + @echo "Build finished. Now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + @echo "Build finished. Now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/UnderstandingAccountingForEntrepreneurs.qhcp" @echo "To view the help file:" @@ -118,7 +122,7 @@ epub: latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Build finished. The LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." @@ -126,14 +130,14 @@ latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + @echo "pdflatex finished. The PDF files are in $(BUILDDIR)/latex." cp $(BUILDDIR)/latex/*.pdf $(BUILDDIR)/html/ latexpdfja: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through platex and dvipdfmx..." $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + @echo "pdflatex finished. The PDF files are in $(BUILDDIR)/latex." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @@ -156,7 +160,7 @@ info: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo "Running Texinfo files through makeinfo..." make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + @echo "makeinfo finished. The Info files are in $(BUILDDIR)/texinfo." gettext: $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) locale/sources @@ -171,12 +175,12 @@ changes: linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo - @echo "Link check complete; look for any errors in the above output " \ + @echo "Link check complete. Look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ + @echo "Testing of doctests in the sources finished. Look at the " \ "results in $(BUILDDIR)/doctest/output.txt." xml: diff --git a/_static/banners/sign_eLearning.jpg b/_static/banners/sign_eLearning.jpg new file mode 100644 index 000000000..a29b7b3a5 Binary files /dev/null and b/_static/banners/sign_eLearning.jpg differ diff --git a/_static/banners/support.jpg b/_static/banners/support.jpg new file mode 100644 index 000000000..68e4d41d4 Binary files /dev/null and b/_static/banners/support.jpg differ diff --git a/_static/coa-valuation-continental.js b/_static/coa-valuation-continental.js index 6fc66f09f..9db7f8b80 100644 --- a/_static/coa-valuation-continental.js +++ b/_static/coa-valuation-continental.js @@ -225,7 +225,7 @@ }, { label: "Vendor Invoice (PO €48, Invoice €50)", operations: [ - {account: EXPENSES.PURCHASED_GOODS.code, debit: constant(48)}, + {account: EXPENSES.PURCHASED_GOODS.code, debit: constant(50)}, {account: ASSETS.TAXES_PAID.code, debit: constant(50 * 0.09)}, {account: LIABILITIES.ACCOUNTS_PAYABLE.code, credit: constant(50 * 1.09)}, ] diff --git a/_static/files/barcodes_actions.pdf b/_static/files/barcodes_actions.pdf deleted file mode 100644 index 2bc8ee33c..000000000 Binary files a/_static/files/barcodes_actions.pdf and /dev/null differ diff --git a/accounting/bank/feeds/synchronize.rst b/accounting/bank/feeds/synchronize.rst index 6170afe72..662f50a31 100644 --- a/accounting/bank/feeds/synchronize.rst +++ b/accounting/bank/feeds/synchronize.rst @@ -86,10 +86,10 @@ from the accounting dashboard. Moreover, a transaction can be visible in your bank account but not being fetched by Yodlee. Indeed, the transaction in your bank account can have the status "pending" and not the status "posted". In that case, Yodlee won't import it, you will have to -wait that the status changes. +wait till the status changes. What is important to remember is that Yodlee is not a service fetching transactions -in real time. This is a service to facilitate the import of the bank statement in the database. +in real time. This is a service to facilitate the import of the bank statements to the database. Is the Yodlee feature included in my contract? ---------------------------------------------- @@ -103,10 +103,10 @@ Some banks have a status "Beta", what does it mean? This means that Yodlee is only currently working on developing the synchronization with this bank. The synchronization could already work or it may need a bit more time -to have a 100% working synchronization. Unfortunately, there is not much to do about -except being patient. +to have a 100% working synchronization. Unfortunately, there is not much to do about it +except for being patient. All my past transactions are not in Odoo, why? ---------------------------------------------- -Yodlee only allows to fetch up transactions to 3 months in the past. +Yodlee only allows to fetch transactions up to 3 months in the past. diff --git a/accounting/bank/misc/batch.rst b/accounting/bank/misc/batch.rst index 026572e20..d1ddd4f7f 100644 --- a/accounting/bank/misc/batch.rst +++ b/accounting/bank/misc/batch.rst @@ -66,9 +66,9 @@ From checks received to the bank Receive customer checks ----------------------- -Once your record checks received, record them on the bank account on +Once your checks are received, record them on the bank account on which you plan to deposit them. Once you select the bank account (or -check journal is you configured Odoo that way), Odoo proposes you to use +check journal if you configured Odoo that way), Odoo proposes you to use a batch deposit. Select this option if you plan to deposit the check to your bank. @@ -93,7 +93,7 @@ and create a new **Batch Deposit**. Select the bank, then select the payments (checks) you want to add in this deposit. By default, Odoo proposes you all the checks that have not -been deposit yet. That way, you can verify that you do not forget or +been deposited yet. That way you can verify that you do not forget or lost a check. .. image:: media/batch05.png @@ -113,9 +113,9 @@ matches with the bank statement line. .. image:: media/batch06.png :align: center -If you select a batch deposit, Odoo will automatically fills all the +If you select a batch deposit, Odoo will automatically fill all the checks contained in this deposit for the matching. (2 checks were in -this batch deposit the example below) +the batch deposit in the example below) .. image:: media/batch07.png :align: center @@ -129,7 +129,7 @@ I don't see the batch deposit link on bank statements? If you don't have a batch deposit link in your bank statement, there could be two reasons: -- After having installed the batch deposit features, you need to reload +- After having installed the batch deposit features you need to reload the page so that the browser is aware of this new feature. Just click the reload button of your browser. @@ -142,5 +142,5 @@ If you have a smaller amount in your bank statement than the actual amount in your batch deposit, it probably means that one of your check has been refused. -In this case, click on the line related to this check to remove it from +In this case click on the line related to this check to remove it from the bank statement matching. diff --git a/accounting/bank/misc/interbank.rst b/accounting/bank/misc/interbank.rst index e01c3e620..ba03b7297 100644 --- a/accounting/bank/misc/interbank.rst +++ b/accounting/bank/misc/interbank.rst @@ -18,8 +18,8 @@ Check your Chart of Accounts and default transfer account To handle internal transfers you need a transfer account in your charts of account. Odoo will generate an account automatically based on the -country of your chart of account. To parameter your chart of account and -check the default transfer account go into your the accounting module, +country of your chart of account. To configure your chart of accounts and +check the default transfer account go into the accounting module settings, select :menuselection:`Configuration --> Settings`. Your chart of accounts will be pre-installed depending on the country @@ -61,8 +61,8 @@ We will now transfer 50.000 euros from our **Bank** to our **Bank BE57 0633 Log an internal transfer ------------------------ -The first step is to register the internal paiement. To do so, go into -your accounting dashboard. click on the **more** button of one of your banks +The first step is to register the internal payment. To do so go into +your accounting dashboard, click on the **more** button of one of your banks and select :menuselection:`New --> Internal transfer`. .. image:: media/interbank01.png @@ -96,7 +96,7 @@ statement of your bank. :align: center That is because we did not import the bank statement confirming the -departure and arrival of the money. It's thus necessary to import your +receiving and sending of the money. It's thus necessary to import your bank statement and reconcile the payment with the correct bank statement line. Once you receive your bank statements click the **new statement** button of the corresponding bank to import them. @@ -117,16 +117,16 @@ The following window will open: .. image:: media/interbank09.png :align: center -You need to choose counterparts for the paiement. Select the correct -bank statement line corresponding to the paiement and click on the +You need to choose counterparts for the payment. Select the correct +bank statement line corresponding to the payment and click on the **reconcile** button. Close the statement to finish the transaction .. image:: media/interbank08.png :align: center The same steps will need to be repeated once you receive your second -bank statement. Note that if you specify the correct amount, and the -same memo in both bank statement and payment transaction then the +bank statement. Note that if you specify the same amount and the +same memo in both bank statements and payment transactions then the reconciliation will happen automatically. .. image:: media/interbank12.png diff --git a/accounting/bank/reconciliation/use_cases.rst b/accounting/bank/reconciliation/use_cases.rst index e2cfc415f..b8428d491 100644 --- a/accounting/bank/reconciliation/use_cases.rst +++ b/accounting/bank/reconciliation/use_cases.rst @@ -5,22 +5,18 @@ Use cases in the bank reconciliation process? Overview ======== -Linking your bank statements with your accounting can be a lot of work. -You need to find invoices back, relate payments and that amount of -administration can cast a lot of time. Luckily, with Odoo you can very -easily link your invoices or any other payment with your bank -statements. +Matching your bank statements with your accounting records can be a tedious task. You need to find the corresponding invoices, compare the amounts and partners' details with those in the bank statement. These steps can take a lot of time. Luckily, with Odoo you can very easily match your invoices or any other payment document with your bank statements. -Two reconciliation processes exist in Odoo. +Two options of the reconciliation process exist in Odoo. -1. We can directly register a payment on the invoices +1. We can directly specify the payment on the invoice 2. We can reconcile open invoices with bank statements Configuration ============= -No special configuration is necessary to register invoices. All we need -to do is install the accounting app. +No special configuration is necessary to record invoices. All we need +to do is to install the accounting app. .. image:: media/use01.png :align: center @@ -31,13 +27,13 @@ Use cases Case 1: Payments registration ----------------------------- -We received the payment proof for our invoice of 2100 euros issued to +We received the proof of payment of our invoice in the amount of 2100 euros issued to Smith & Co. We start at our issued Invoice of 2100 euros for Smith & Co. Because the sold product is a service we demand an immediate payment. Our accountant -only handles the bank statements at the end of week, so we have to mark -the invoice as paid so we can remember we can start the service with our +only handles bank statements at the end of week, so we have to mark +this invoice as paid immediately in order to indicate that we can start rendering services to our customer. Our customer send us a payment confirmation. We can thus register a @@ -47,13 +43,13 @@ payment and mark the invoice as paid. :align: center By clicking on **register payment,** we are telling Odoo that our -customer paid the Invoice. We thus have to specify the amount and the -payment method +customer has paid the Invoice. We thus have to specify the amount and the +payment method. .. image:: media/use03.png :align: center -We can always find the payment back from the Invoice by clicking on the +Now we can always find the payment details in the Invoice by clicking on the :menuselection:`Info --> Open Payment`. .. image:: media/use04.png @@ -71,8 +67,8 @@ assume that other Invoices are open for different customers. .. image:: media/use05.png :align: center -We receive our bank statement and not only the invoice of Smith & Co has -been paid, the one of Buzz of 92 euros as well. +We receive our bank statement and find that not only the invoice issued to Smith & Co has +been paid, but the one to Buzz of 92 euros as well. **Import** or **Create** the bank statements. Please refer to the documents from the Bank Feeds section. diff --git a/accounting/localizations/mexico.rst b/accounting/localizations/mexico.rst index 693fd0e38..cc600de0c 100644 --- a/accounting/localizations/mexico.rst +++ b/accounting/localizations/mexico.rst @@ -15,7 +15,7 @@ Introduction The mexican localization is a group of 3 modules: -1. **l10n_mx:** All the basic data to manage the accounting, taxes and the +1. **l10n_mx:** All basic data to manage the accounting, taxes and the chart of account, this proposed chart of account installed is a intended copy of the list of group codes offered by the `SAT`_. 2. **l10n_mx_edi**: All regarding to electronic transactions, CFDI 3.2 and 3.3, @@ -62,6 +62,8 @@ integrate with the normal invoicing flow in Odoo. .. image:: media/mexico02.png :align: center +.. _mx-legal-info: + 3. Set you legal information in the company ------------------------------------------- diff --git a/accounting/others/adviser/budget.rst b/accounting/others/adviser/budget.rst index f7b5e1bed..bd7ed6ae9 100644 --- a/accounting/others/adviser/budget.rst +++ b/accounting/others/adviser/budget.rst @@ -5,9 +5,12 @@ How to manage a financial budget? Overview ======== -Managing budgets is an essential part of running a business. It allows -you to measure your actual financial performance against the planned -one. Odoo manages its budgets using both General and Analytic Accounts. +Managing budgets is an essential part of running a business. Budgets help +people become more intentional with the way money is spent and direct people +to organize and prioritize their work to meet financial goals. They allows +you to plan your desired financial outcome and then measure your actual +performance against the plan. Odoo manages budgets using both General and Analytic +Accounts. We will use the following example to illustrate. We just started a project with Smith&Co and we would like to budget the incomes and @@ -34,10 +37,23 @@ management** feature Budgetary Positions ------------------- -Budgetary positions are the general accounts for which you want to keep +Budgetary positions are lists of accounts for which you want to keep budgets (typically expense or income accounts). They need to be defined so Odoo can know it which accounts he needs to go get the budget -information. Some might be already installed with your chart of +information. + +The budgetary positions act as a type of restriction on what can be recorded +in the 'practical amount' column in a budget. + +Each budgetary position can have any number of accounts from the general +ledger (the main chart of accounts) assigned to it, though it must have at least one. + +If you record a transaction that has an analytic account assigned to it that *is* +included in a budget line but one of the general ledger accounts *is not* included +in the budgetary position for that same budget line, it will not appear within the +'practical amount' column of that budget line. + +Some budgetary positions might be already installed with your chart of accounts. To define the positions enter the :menuselection:`Accounting module --> Configuration --> diff --git a/accounting/others/reporting/customize.rst b/accounting/others/reporting/customize.rst index 7c358bc08..02cfae75c 100644 --- a/accounting/others/reporting/customize.rst +++ b/accounting/others/reporting/customize.rst @@ -5,9 +5,10 @@ How to create a customized reports with your own formulas? Overview ======== -Odoo 9 comes with a powerful and easy-to-use reporting framework. -Creating new reports (such as a tax report or a balance sheet for a -specific country) to suit your needs is now easier than ever. +Odoo 13 comes with a powerful and easy-to-use reporting framework. +Creating new reports (such as a tax report or a balance sheet or +income statement with specific groupings and layout ) to suit your +needs is now easier than ever. Activate the developer mode =========================== @@ -33,21 +34,21 @@ First, you need to create your financial report. To do that, go to .. image:: media/customize02.png :align: center -Once the name is filled, there are two other parameters that need to be +Once the name is entered, there are two other parameters that need to be configured: - **Show Credit and Debit Columns** - **Analysis Period** : - - Based on date ranges (eg Profit and Loss) + - Based on date ranges (e.g. Profit and Loss) - - Based on a single date (eg Balance Sheet) + - Based on a single date (e.g. Balance Sheet) - Based on date ranges with 'older' and 'total' columns and last 3 - months (eg. Aged Partner Balances) + months (e.g. Aged Partner Balances) - - Bases on date ranges and cash basis method (eg Cash Flow + - Bases on date ranges and cash basis method (e.g. Cash Flow Statement) Add lines in your custom reports @@ -95,4 +96,4 @@ Other useful fields : (always displayed) or ``never`` (never shown). .. seealso:: - * :doc:`main_reports` \ No newline at end of file + * :doc:`main_reports` diff --git a/accounting/overview/process_overview/customer_invoice.rst b/accounting/overview/process_overview/customer_invoice.rst index 3d9b188fb..f64454d6f 100644 --- a/accounting/overview/process_overview/customer_invoice.rst +++ b/accounting/overview/process_overview/customer_invoice.rst @@ -70,7 +70,7 @@ The document is composed of three parts: Open or Pro-forma invoices ========================== -An invoice will usually include the quantity and price the of goods +An invoice will usually include the quantity and the price of goods and/or services, the date, any parties involved, the unique invoice number, and any tax information. @@ -222,7 +222,7 @@ Revenues and Expenses." Balance sheet ============= -The balance sheet summarizes the your company's liabilities, +The balance sheet summarizes your company's liabilities, assets and equity at a specific moment in time. .. image:: ./media/invoice15.png diff --git a/accounting/payables/supplier_bills/manage.rst b/accounting/payables/supplier_bills/manage.rst index 42c3bc555..e17ef5fa0 100644 --- a/accounting/payables/supplier_bills/manage.rst +++ b/accounting/payables/supplier_bills/manage.rst @@ -34,7 +34,7 @@ Installing the Purchase and Inventory applications -------------------------------------------------- From the **Apps** application, search for the **Purchase** module and -install it. Due to certain dependencies, Installing Purchase will +install it. Due to certain dependencies, installing Purchase will automatically install the **Inventory** and **Accounting** applications. Creating products @@ -42,13 +42,13 @@ Creating products Creating products in Odoo is essential for quick and efficient purchasing within Odoo. Simply navigate to the Products submenu under -Purchase, and click create. +Purchase and click create. .. image:: ./media/manage01.png :align: center -When creating the product, Pay attention to the **Product Type** field, -as it is important: +When creating the product, pay attention to the **Product Type** field, +since it is important: - Products that are set as **Stockable or Consumable** will allow you to keep track of their inventory levels. These options imply @@ -64,7 +64,7 @@ as it is important: It is recommended that you create a **Miscellaneous** product for all purchases that occur infrequently and do not require inventory valuation or management. - If you create such a product, it is recommend to set the product type to **Service**. + If you create such a product, it is recommended to set the product type to **Service**. Managing your Vendor Bills ========================== @@ -90,14 +90,14 @@ Receiving Products If you purchased any stockable products that you manage the inventory of, you will need to receive the products from the Inventory application -after you confirm a Purchase Order. From the **Inventory dashboard**, you +after you confirm a purchase order. From the **Inventory dashboard**, you should see a button linking you directly to the transfer of products. This button is outlined in red below: .. image:: ./media/manage03.png :align: center -Navigating this route will take you to a list of all orders awaiting to +Navigating this route will take you to a list of all orders waiting to be received. .. image:: ./media/manage04.png @@ -105,8 +105,8 @@ be received. If you have a lot of awaiting orders, apply a filter using the search bar in the upper right. With this search bar, you may filter based on -the Vendor (Partner), the product, or the source document, also known as -the reference of your purchase order. You also have the capability to +the vendor (partner), the product, or the source document (also known as +the reference of your purchase order). You can also group the orders by different criteria under **Group By**. Selecting an item from this list will open the following screen where you then will receive the products. @@ -119,7 +119,7 @@ Purchasing service products does not trigger a delivery order. Managing Vendor Bills --------------------- -When you receive a Vendor Bill for a previous purchase, be sure to +When you receive a vendor bill for a previous purchase, be sure to record it in the Purchases application under the **Control Menu**. You need to create a new vendor bill even if you already registered a purchase order. @@ -127,21 +127,21 @@ purchase order. .. image:: ./media/manage06.png :align: center -The first thing you will need to do upon creating a Vendor Bill is to -select the appropriate Vendor as this will also pull up any associated +The first thing you will need to do upon creating a vendor bill is to +select the appropriate vendor, since doing so will also pull up any associated accounting or pricelist information. From there, you can choose to -specify any one or multiple Purchase Orders to populate the Vendor Bill +specify one or multiple Purchase Orders to populate the Vendor Bill with. When you select a Purchase Order from the list, Odoo will pull any uninvoiced products associated to that Purchase Order and automatically populate that information below. If you are having a hard time finding -the appropriate Vendor bill, you may search through the list by +the appropriate vendor bill, you may search through the list by inputting the vendor reference number or your internal purchase order number. .. image:: ./media/manage07.png :align: center -While the invoice is in draft state, you can make any modifications you +While the invoice is in a draft state, you can make any modifications you need (i.e. remove or add product lines, modify quantities, and change prices). @@ -166,18 +166,18 @@ Vendor Bill Matching What to do if your vendor bill does not match what you received --------------------------------------------------------------- -If the bill you receive from the vendor has different quantities than -what Odoo automatically populates as quantities, this could be due to +If the bill you receive from the vendor has quantities that do not match +the quantities automatically populated by Odoo, this could be due to several reasons: -- the vendor is incorrectly charging you for products and/or services - that you have not ordered, +- The vendor is incorrectly charging you for products and/or services + that you have not ordered. -- the vendor is billing you for products that you might not have +- The vendor is billing you for products that you might not have received yet, as the invoicing control may be based on ordered or - received quantities, + received quantities. -- or the vendor did not bill you for previously purchased products. +- The vendor did not bill you for previously purchased products. In these instances it is recommended that you verify that the bill, and any associated purchase order to the vendor, are accurate and that you @@ -186,13 +186,13 @@ understand what you have ordered and what you have already received. If you are unable to find a purchase order related to a vendor bill, this could be due to one of a few reasons: -- the vendor has already invoiced you for this purchase order, - therefore it is not going to appear anywhere in the selection, +- The vendor has already invoiced you for this purchase order; + therefore it is not going to appear anywhere in the selection. -- someone in the company forgot to record a purchase order for this - vendor, +- Someone in the company forgot to record a purchase order for this + vendor. -- or the vendor is charging you for something you did not order. +- The vendor is charging you for something you did not order. @@ -223,7 +223,7 @@ Batch Billing ------------- When creating a vendor bill and selecting the appropriate purchase -order, you may continue to select additional purchase orders and Odoo -will add the additional line items from that purchase order.. If you -have not deleted the previous line items from the first purchase order +order, you may continue to select additional purchase orders. Odoo +will add the additional line items from the purchase orders you select. If you +have not deleted the previous line items from the first purchase order, the bill will be linked to all the appropriate purchase orders. diff --git a/crm/acquire_leads/generate_from_website.rst b/crm/acquire_leads/generate_from_website.rst index fca2295cf..64e4d1855 100644 --- a/crm/acquire_leads/generate_from_website.rst +++ b/crm/acquire_leads/generate_from_website.rst @@ -13,7 +13,7 @@ You should first go to your website app. |image0|\ |image1| -With the CRM app installed, you benefit from ready-to-use contact form +With the CRM app installed, you benefit from a ready-to-use contact form on your Odoo website that will generate leads/opportunities automatically. @@ -32,15 +32,15 @@ Create a custom contact form ============================ You may want to know more from your visitor when they use the contact form to -contact you. You will then need to build a custom contact form on your -website. Those contact forms can generate multiple types of records in +you will need to build a custom contact form on your +website. These contact forms can generate multiple types of records in the system (emails, leads/opportunities, project tasks, helpdesk -tickets, etc...) +tickets, etc.) Configuration ============= -You will need to install the free *Form Builder* module. Only +You will need to install the free *Form Builder* module, only available in Odoo Enterprise. .. image:: media/generate_from_website05.png @@ -49,25 +49,25 @@ available in Odoo Enterprise. Create a custom contact form ---------------------------- -From any page you want your contact form to be in, in edit mode, drag -the form builder in the page and you will be able to add all the fields +First, go to the page where you want to put your contact form. In edit mode, drag +the form builder onto the page, and you will be able to add all the fields you wish. .. image:: media/generate_from_website06.png :align: center -By default any new contact form will send an email, you can switch to +By default, any new contact form will send an email. You can switch to lead/opportunity generation in *Change Form Parameters*. .. note:: If the same visitor uses the contact form twice, the second - information will be added to the first lead/opportunity in the chatter. + entry will be added to the first lead/opportunity in the chatter. Generate leads instead of opportunities ======================================= -When using a contact form, it is advised to use a qualification step -before assigning to the right sales people. To do so, activate *Leads* +When using a contact form, you should use a qualification step +before assigning the form to the right sales people. To do so, activate *Leads* in CRM settings and refer to :doc:`convert`. .. |image0| image:: ./media/generate_from_website01.png diff --git a/db_management/db_premise.rst b/db_management/db_premise.rst index db8419aa7..3129d75cf 100644 --- a/db_management/db_premise.rst +++ b/db_management/db_premise.rst @@ -2,9 +2,9 @@ .. _db_premise: -============================== -On-premise Database management -============================== +=============================== +On-premises Database management +=============================== Register a database =================== @@ -116,7 +116,7 @@ or * **Deactivate users** as explained in this `Documentation `__ + /documentation/user/13.0/db_management/documentation.html#deactivating-users>`__ and **Reject** the upsell quotation. Once your database has the correct number of users, the expiration message @@ -154,6 +154,8 @@ None of those solutions worked for you? Please contact our .. _force_ping: +.. _duplicate_premise: + Duplicate a database ==================== diff --git a/ecommerce/shopper_experience/paypal.rst b/ecommerce/shopper_experience/paypal.rst index 1c3139623..8b1a5c1b6 100644 --- a/ecommerce/shopper_experience/paypal.rst +++ b/ecommerce/shopper_experience/paypal.rst @@ -97,6 +97,9 @@ Click *More Options* and set the two default encoding formats as Your Paypal account is ready! + .. tip:: For Encrypted Website Payments & EWP_SETTINGS error, + please check the `paypal documentation. `__ + Settings in Odoo ================ @@ -167,15 +170,9 @@ Log in to `Paypal Developer Site `__ with your Pa This will create two sandbox accounts: -- A business account - (to use as merchant, e.g. - `pp.merch01-facilitator@example.com `__). +- A business account (to use as merchant, e.g. `pp.merch01-facilitator@example.com `__). - Log in to `Paypal Developer Site `__ with your Paypal credentials. - -- A default personal account - (to use as shopper, e.g. - `pp.merch01-buyer@example.com `__). +- A default personal account (to use as shopper, e.g. `pp.merch01-buyer@example.com `__). Log in to Paypal Sandbox with the merchant account and follow the same configuration instructions. Enter your sandbox credentials in Odoo and make sure Paypal is still diff --git a/general/auth.rst b/general/auth.rst index 7f9055ab2..e84d90b98 100644 --- a/general/auth.rst +++ b/general/auth.rst @@ -6,4 +6,6 @@ Authentication :titlesonly: auth/google - auth/azure \ No newline at end of file + auth/azure + auth/ldap + diff --git a/general/auth/ldap.rst b/general/auth/ldap.rst new file mode 100644 index 000000000..cdabd8335 --- /dev/null +++ b/general/auth/ldap.rst @@ -0,0 +1,44 @@ +======================================= +How to allow users to sign in with LDAP +======================================= + +- Install the LDAP module in General Settings. + +- Click on **Create** in Setup your LDAP Server. + +.. image:: media/ldap01.png + :align: center + +.. image:: media/ldap02.png + :align: center + +- Choose the company about to use the LDAP. + +.. image:: media/ldap03.png + :align: center + +- In **Server Information**, enter the IP address of your server and the port it listens to. + +- Tick **User TLS** if your server is compatible. + +.. image:: media/ldap04.png + :align: center + +- In **Login Information**, enter ID and password of the account used to query the server. If left empty, the server will be queried anonymously. + +.. image:: media/ldap05.png + :align: center + +- In **Process Parameter**, enter the domain name of your LDAP server in LDAP nomenclature (e.g. ``dc=example,dc=com``). + +- In **LDAP filter**, enter ``uid=%s`` + +.. image:: media/ldap06.png + :align: center + +- In **User Information**, tick *Create User* if you want Odoo to create a User profile the first time someone log in with LDAP. + +- In **Template User**, indicate a template for the new profiles created. If left blanked, the admin profile will be used as template. + +.. image:: media/ldap07.png + :align: center diff --git a/general/auth/media/ldap01.png b/general/auth/media/ldap01.png new file mode 100644 index 000000000..6dc4354bd Binary files /dev/null and b/general/auth/media/ldap01.png differ diff --git a/general/auth/media/ldap02.png b/general/auth/media/ldap02.png new file mode 100644 index 000000000..7e65eb5e1 Binary files /dev/null and b/general/auth/media/ldap02.png differ diff --git a/general/auth/media/ldap03.png b/general/auth/media/ldap03.png new file mode 100644 index 000000000..93482c002 Binary files /dev/null and b/general/auth/media/ldap03.png differ diff --git a/general/auth/media/ldap04.png b/general/auth/media/ldap04.png new file mode 100644 index 000000000..7199e9a2c Binary files /dev/null and b/general/auth/media/ldap04.png differ diff --git a/general/auth/media/ldap05.png b/general/auth/media/ldap05.png new file mode 100644 index 000000000..f80e9cd40 Binary files /dev/null and b/general/auth/media/ldap05.png differ diff --git a/general/auth/media/ldap06.png b/general/auth/media/ldap06.png new file mode 100644 index 000000000..b652747af Binary files /dev/null and b/general/auth/media/ldap06.png differ diff --git a/general/auth/media/ldap07.png b/general/auth/media/ldap07.png new file mode 100644 index 000000000..045f07472 Binary files /dev/null and b/general/auth/media/ldap07.png differ diff --git a/general/base_import/import_faq.rst b/general/base_import/import_faq.rst index d13626b9d..8593d7ff7 100644 --- a/general/base_import/import_faq.rst +++ b/general/base_import/import_faq.rst @@ -78,7 +78,7 @@ you will then be able to choose from the complete list of fields for each column Where can I change the date import format? ------------------------------------------ -Odoo can automatically detect if a column is a date and it will try to guess the date format from a set of most used date format. While this process can work for a lot of simple date format, some exotic date format will not be recognize and it is also possible to have some confusion (day and month inverted as example) as it is difficult to guess correctly which part is the day and which one is the month in a date like '01-03-2016'. +Odoo can automatically detect if a column is a date, and it will try to guess the date format from a set of most commonly used date formats. While this process can work for many date formats, some date formats will not be recognized. This can cause confusion due to day-month inversions; it is difficult to guess which part of a date format is the day and which part is the month in a date such as '01-03-2016'. To view which date format Odoo has found from your file you can check the **Date Format** that is shown when clicking on **Options** under the file selector. If this format is incorrect you can change it to your liking using the *ISO 8601* to define the format. @@ -247,4 +247,4 @@ It will produce the following CSV file:: As you can see in this file, Fabien and Laurence are working for the Bigees company (company_1) and Eric is working for the Organi company. The relation between persons and companies is done using the External ID of the companies. We had to prefix the "External ID" by the name of the table to avoid a conflict of ID between persons and companies (person_1 and company_1 who shared the same ID 1 in the orignial 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. \ No newline at end of file +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. diff --git a/general/unsplash/unsplash_access_key.rst b/general/unsplash/unsplash_access_key.rst index c7341f412..5dc39a3b5 100644 --- a/general/unsplash/unsplash_access_key.rst +++ b/general/unsplash/unsplash_access_key.rst @@ -3,7 +3,7 @@ How to generate an Unsplash access key ======================================================= .. tip:: - **As a SaaS user**, Unsplash is ready to use. You won't need to follow this guide to set up Unsplash informations as you will use our own Odoo Unsplash key in a transparent way. + **As an SaaS user**, you are ready to use Unsplash. You won't need to follow this guide to set up Unsplash informations, since you will use our own Odoo Unsplash key in a transparent way. Generate an Unsplash access key for **non-Saas** users ====================================================== @@ -20,7 +20,7 @@ Generate an Unsplash access key for **non-Saas** users .. 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 it can be recognized as an Odoo instance by Unsplash. Once done, click on **Create application**. +- 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 @@ -31,7 +31,7 @@ Generate an Unsplash access key for **non-Saas** users :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. + **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/getting_started/documentation.rst b/getting_started/documentation.rst index 5ddd6a336..1e7614346 100644 --- a/getting_started/documentation.rst +++ b/getting_started/documentation.rst @@ -115,7 +115,7 @@ into account from the beginning of the project: gap to be filled by developments/customizations or changes in business processes. -- `The User Story `__: +- **The User Story**: This technique clearly separates the responsibilities between the SPoC, responsible for explaining the WHAT, the WHY and the WHO, and the Consultant who will provide a response to the HOW. @@ -252,42 +252,7 @@ as possible, it will be decided : 8. Support ========== -Your Odoo Online subscription includes **unlimited 24hr support at no extra -cost, Monday to Friday**. Our teams are located around the world to ensure you -have support, no matter your location. Your support representative could be -communicating to you from San Francisco, Belgium, or India! +When your project is put in production, our support teams take care of your +questions or technical issues. -What kind of support is included? - -- Providing you with relevant material (guidelines, product documentation, - etc...) -- Answers to issues that you may encounter in your standard Odoo database (eg. - “I cannot close my Point of Sale” or “I cannot find my sales KPIs?”) -- Questions related to your account, subscription, or billing -- Bug resolution (blocking issues or unexpected behaviour not due to - misconfiguration or customization) -- Issues that might occur in a test database after upgrading to a newer version - -*Odoo Support does not make changes to your production database, but gives you -the material and knowledge to do it yourself!* - -What kind of support is not included? - -- Questions that require us to understand your business processes in order to - help you implement your database -- Training on how to use our software (we will direct you to our many resources) -- Import of documents into your database -- Guidance on which configurations to apply inside of an application or the database -- How to set up configuration models (Examples include: Inventory Routes, - Payment Terms, Warehouses, etc) -- Questions or issues related to specific developments or customizations done - either by Odoo or a third party (this is specific only to your database or - involving code) - -You can get this type of support with a `Success Pack `__. -With a pack, one of our consultants will analyze the way your business runs and -tell you how you can get the most out of your Odoo Database. We will handle all -configurations and coach you on how to use Odoo. - -Our support team can be contacted through our -`online support form `__. +See :ref:`support-expectations`. diff --git a/helpdesk/getting_started.rst b/helpdesk/getting_started.rst index 4a2f4d5a5..c8dbaa4d6 100644 --- a/helpdesk/getting_started.rst +++ b/helpdesk/getting_started.rst @@ -85,7 +85,7 @@ Ticket. The final option to submit tickets is thru an API connection. View the documentation -`*here* `__. +`*here* `__. Tickets have been created, now what? ------------------------------------ diff --git a/inventory/barcode/setup/hardware.rst b/inventory/barcode/setup/hardware.rst index 97a0ebe3f..3abf27940 100644 --- a/inventory/barcode/setup/hardware.rst +++ b/inventory/barcode/setup/hardware.rst @@ -26,13 +26,13 @@ scanner** and the **mobile computer scanner**. is a good choice if you want to be mobile but don't need a big investment. An approach is to log in Odoo on you smartphone, pair the bluetooth scanner with the smartphone and work in the - warehouse with always the possibility to check your smartphone + warehouse with the possibility to check your smartphone from time to time and use the software 'manually'. - For heavy use, the **mobile computer scanner** is the handiest solution. - It consists in a small computer with a built-in barcode scanner. + It consists of a small computer with a built-in barcode scanner. This one can turn out to be a very productive solution, however - you need to make sure that is is capable of running Odoo smoothy. + you need to make sure that is is capable of running Odoo smoothly. The most recent models using Android + Google Chrome or Windows + Internet Explorer Mobile should do the job. However, due to the variety of models and configurations on the market, it is diff --git a/inventory/barcode/setup/software.rst b/inventory/barcode/setup/software.rst index 7c492f004..a0ec0d9d2 100644 --- a/inventory/barcode/setup/software.rst +++ b/inventory/barcode/setup/software.rst @@ -8,17 +8,6 @@ attributing barcodes to products, pickings locations, etc. allows you to work more efficiently by controlling the software almost exclusively with the barcode scanner. -.. |download_barcode| image:: ../../../_static/banners/pdf-icon.png - :alt: Download Barcode Document - :target: ../../../_static/files/barcodes_actions.pdf - - -.. note:: - Print this document to be able to use your barcode scanner to perform more actions. - - Document: |download_barcode| - - Set products barcodes ===================== diff --git a/inventory/management/delivery/scheduled_dates.rst b/inventory/management/delivery/scheduled_dates.rst index f56fefbb5..438a98114 100644 --- a/inventory/management/delivery/scheduled_dates.rst +++ b/inventory/management/delivery/scheduled_dates.rst @@ -81,7 +81,7 @@ numbers of security days from the calculation and thus to compute a scheduled date earlier than the one you promised to your client. In that way you are sure to be able to keep your commitment. -To set ut your security dates, go to :menuselection:`Settings --> General settings` and +To set up your security dates, go to :menuselection:`Settings --> General settings` and click on **Configure your company data**. .. image:: media/scheduled_dates04.png diff --git a/inventory/management/lots_serial_numbers/serial_numbers.rst b/inventory/management/lots_serial_numbers/serial_numbers.rst index 42ead5e17..50fd3a5c1 100644 --- a/inventory/management/lots_serial_numbers/serial_numbers.rst +++ b/inventory/management/lots_serial_numbers/serial_numbers.rst @@ -66,7 +66,7 @@ numbers. :align: center If you move products that already have serial numbers assigned, those -will appear in the list. Just click on the **+** icon to to confirm that you +will appear in the list. Just click on the **+** icon to confirm that you are moving those serial numbers. .. image:: media/serial_numbers05.png @@ -126,4 +126,4 @@ You can have more details by clicking on the **Traceability** button : .. seealso:: * :doc:`differences` - * :doc:`lots` \ No newline at end of file + * :doc:`lots` diff --git a/inventory/routes/concepts/procurement_rule.rst b/inventory/routes/concepts/procurement_rule.rst index 692313026..ea7863be6 100644 --- a/inventory/routes/concepts/procurement_rule.rst +++ b/inventory/routes/concepts/procurement_rule.rst @@ -43,14 +43,14 @@ In the Procurement rules section, click on Add an item. :align: center Here you can set the conditions of your rule. There are 3 types of -action possibles : +action possible : - Move from another location rules - Manufacturing rules that will trigger the creation of manufacturing - orders. + orders -- Buy rules that will trigger the creation of purchase orders. +- Buy rules that will trigger the creation of purchase orders .. note:: The Manufacturing application has to be installed in order to @@ -74,4 +74,4 @@ action possibles : .. seealso:: * :doc:`push_rule` * :doc:`inter_warehouse` - * :doc:`cross_dock` \ No newline at end of file + * :doc:`cross_dock` diff --git a/inventory/routes/concepts/push_rule.rst b/inventory/routes/concepts/push_rule.rst index 21638787e..5ea5008c6 100644 --- a/inventory/routes/concepts/push_rule.rst +++ b/inventory/routes/concepts/push_rule.rst @@ -13,7 +13,7 @@ meet the forecast demand and sell, or push, the goods to the consumer. Disadvantages of the push inventory control system are that forecasts are often inaccurate as sales can be unpredictable and vary from one year to the next. Another problem with push inventory control systems is -that if too much product is left in inventory. This increases the +that if too much product is left in inventory, this increases the company's costs for storing these goods. An advantage to the push system is that the company is fairly assured it will have enough product on hand to complete customer orders, preventing the inability to meet @@ -82,4 +82,4 @@ be moved to the main stock. .. seealso:: * :doc:`procurement_rule` * :doc:`inter_warehouse` - * :doc:`cross_dock` \ No newline at end of file + * :doc:`cross_dock` diff --git a/inventory/routes/costing/landed_costs.rst b/inventory/routes/costing/landed_costs.rst index 8632c7e83..1ced3fe7d 100644 --- a/inventory/routes/costing/landed_costs.rst +++ b/inventory/routes/costing/landed_costs.rst @@ -11,7 +11,7 @@ insurance, customs duties, etc.) into the cost of the product. .. note:: Landed costs can only be applied to products with a FIFO costing method and an automated inventory valuation (which requires the accounting application - to be instealled). + to be installed). Configuration ============= diff --git a/inventory/routes/strategies/removal.rst b/inventory/routes/strategies/removal.rst index 6f7fb508b..b5a909df5 100644 --- a/inventory/routes/strategies/removal.rst +++ b/inventory/routes/strategies/removal.rst @@ -124,7 +124,7 @@ These dates can be set from :menuselection:`Inventory Control --> Serial Numbers - **Removal Date:** This is the date on which the goods with this serial/lot number should be removed from the stock. Using the FEFO - removal strategym goods are picked for delivery orders using this date. + removal strategy goods are picked for delivery orders using this date. - **Alert Date:** This is the date on which an alert should be sent about the goods with this serial/lot number. diff --git a/inventory/settings/products/uom.rst b/inventory/settings/products/uom.rst index ce31e7f6e..7390d2db6 100644 --- a/inventory/settings/products/uom.rst +++ b/inventory/settings/products/uom.rst @@ -7,7 +7,7 @@ Overview In some cases, handling products in different unit of measures is necessary. For example, if you buy products in a country where the -metric system is of application and sell the in a country where the +metric system is of application and sell them in a country where the imperial system is used, you will need to convert the units. You can set up Odoo to work with different units of measure for one @@ -26,7 +26,7 @@ different units of measure (advanced)**, then click on **Apply**. Setting up units on your products ================================= -In :menuselection:`Inventory Control --> Products`, open the product which you would like to +In :menuselection:`Master Data --> Products`, open the product which you would like to change the purchase/sale unit of measure, and click on **Edit**. In the **Unit of Measure** section, select the unit in which the product @@ -126,4 +126,4 @@ converted automatically : - When should you use packages, units of measure or kits? -.. |edit| image:: ./media/uom07.png \ No newline at end of file +.. |edit| image:: ./media/uom07.png diff --git a/inventory/shipping/operation/invoicing.rst b/inventory/shipping/operation/invoicing.rst index 8136671fc..307e8b9a3 100644 --- a/inventory/shipping/operation/invoicing.rst +++ b/inventory/shipping/operation/invoicing.rst @@ -61,8 +61,8 @@ On your sale order, choose the carrier that will be used. Click on The price is computed when you **save** the sale order. Confirm the sale order and proceed to deliver the product. -The real shipping cost are computed when the delivery order is -validated. +The real shipping cost is computed when the delivery order is +validated, you can see the real cost in the chatter of the delivery order. .. image:: media/invoicing02.png :align: center diff --git a/inventory/shipping/operation/media/invoicing02.png b/inventory/shipping/operation/media/invoicing02.png index 6fc748ac7..3cff60403 100644 Binary files a/inventory/shipping/operation/media/invoicing02.png and b/inventory/shipping/operation/media/invoicing02.png differ diff --git a/legal/others/cla.rst b/legal/others/cla.rst index 55e92bc99..a72969201 100644 --- a/legal/others/cla.rst +++ b/legal/others/cla.rst @@ -9,5 +9,5 @@ have to sign the Odoo Contributor License Agreement (CLA). More information about this requirement, the procedure to sign the agreement, and a FAQ can be found on our -`GitHub project page `_. +`GitHub project page `_. diff --git a/livechat/livechat.rst b/livechat/livechat.rst index 8a5df67a2..c0f893d03 100644 --- a/livechat/livechat.rst +++ b/livechat/livechat.rst @@ -4,8 +4,8 @@ Live Chat ========= -Chat in live with website visitors -================================== +Chat in real time with website visitors +======================================= With Odoo Live Chat, you can establish a direct contact with your website visitors. A simple dialog box will be available on their screen @@ -89,12 +89,12 @@ has joined the channel. unpublished on the website, then the live chat button will not appear to visitors. -In practice, the conversations initiated by the visitors will appear in -the Discuss module and will also pop up as a direct message. Therefore, +Conversations initiated by visitors also appear in +the Discuss module in addition to popping up as a direct message. Therefore, inquiries can be answered wherever you are in Odoo. -If there several operators in charge of a channel, the system will -dispatch sessions randomly between them. +If there are several operators who have all joined a channel, the system will +dispatch visitor sessions randomly between them. Use commands ============ diff --git a/manufacturing/management.rst b/manufacturing/management.rst index c0cbc102f..fe1571695 100644 --- a/manufacturing/management.rst +++ b/manufacturing/management.rst @@ -12,6 +12,10 @@ Manufacturing Management management/kit_shipping management/product_variants management/sub_assemblies + management/flexible_components_consumption + management/plan_work_orders + management/alternative_wc management/unbuild management/subcontracting management/routing_kit_bom + management/use_mps diff --git a/manufacturing/management/alternative_wc.rst b/manufacturing/management/alternative_wc.rst new file mode 100644 index 000000000..fd70620ac --- /dev/null +++ b/manufacturing/management/alternative_wc.rst @@ -0,0 +1,80 @@ +================================ +Using an alternative Work Center +================================ + +For many manufacturing companies, a common issue is to have to +manufacture, at the same time, several products usually produced at the +same work center. If in practice, employees can manufacture the goods at +another work center, it is not that simple. + +You need to keep track of the job: which work center has been used and +when, so you can schedule maintenance efficiently. With Odoo, you can +configure it so you can keep tracking manufacturing orders and your +employees have an alternative work center to use. + +This way, your process becomes more efficient, and less non-productive +time will be noticed. + + +Configure your Work Centers +=========================== + +The first thing to do is to go to the *Manufacturing* app settings. +Then, enable the *Work Orders* feature and hit save. + + +.. image:: media/alternative_wc_01.png + :align: center + + +Now, go to the *Work Centers* menu under *Master Data* and create +two new work centers. Add the second work centers as an alternative to +the first and vice versa. + + +.. image:: media/alternative_wc_02.png + :align: center + + +The next step is to create your *routing*. Add your work center and an +operation to it before saving. + + +.. image:: media/alternative_wc_03.png + :align: center + + +Then, you can create your *Bill of Materials* and add components and +routing to it. + + +.. image:: media/alternative_wc_04.png + :align: center + + +Create your Work Orders +======================= + +Now that everything is configured, you can create your *Work Orders*. +Go to the *Manufacturing Orders* menu and hit *Create*. There, add +your product and plan it. In the *Work Orders* list, you can find it +ready to be assembled. + + +.. image:: media/alternative_wc_05.png + :align: center + + +Each new *Work Order*, which will be created before the end of the +first one, will be scheduled at the alternative work center you +configured. + + +.. image:: media/alternative_wc_06.png + :align: center + + +.. note:: + Keep in mind that, if you add time after production to your work center, + you may have work orders scheduled for your alternative work center even + if the usual one is free. \ No newline at end of file diff --git a/manufacturing/management/bill_configuration.rst b/manufacturing/management/bill_configuration.rst index 432082fb7..20b82a128 100644 --- a/manufacturing/management/bill_configuration.rst +++ b/manufacturing/management/bill_configuration.rst @@ -1,140 +1,91 @@ -================================= -How to create a Bill of Materials -================================= - -A bill of materials (BoM) is a document that describes the component -products, the quantity of each component, and the process required to -manufacture a product, including a routing and individual steps. - -In Odoo, each product may have multiple BoMs associated with it, but a -BoM can only be associated with a single product. A single BoM can, -however, describe multiple variants of the same product. - -Setting up a Basic BoM -====================== - -If you choose to manage your manufacturing operations using manufacturing -orders only, you will define basic bills of materials without routings. - -Before creating your first bill of materials, you will need to create a -product and at least one component (components are considered products -in Odoo). You can do so from :menuselection:`Master Data --> Products`, or -on the fly from the relevant fields on the BoM form. Review the -Inventory chapter for more information about configuring products. Once -you have created a product and at least one component, select them from -the relevant dropdown menus to add them to your bill of materials. A new -bill of materials can be created from :menuselection:`Master Data --> Bills of Materials`, -or using the button on the top of the product form. - -Under the **Miscellaneous** tab, you can fill additional fields. -**Sequence** defines the order in which your BoMs will be selected -for production orders, with lower numbers having higher priority. -**Version** allows you to track changes to your BoM over time. - -Adding a Routing to a BoM +========================= +Create Bills of Materials ========================= -A routing defines a series of operations required to manufacture a -product and the work center at which each operation is performed. A -routing may be added to multiple BoMs, though a BoM may only have one -routing. For more information about configuring routings, review the -chapter on routings. +A *Bill of Materials* is a document defining the quantity of each +component required to manufacture a finished product. It also includes +the routing and individual steps of the manufacturing process. -After enabling routings from :menuselection:`Configuration --> Settings`, -you will be able to add a routing to a bill of materials by selecting a -routing from the dropdown list or creating one on the fly. +With Odoo, you can link multiple BoMs to each product and use it to +describe multiple variants of them. Each BoM will, yet, be associated +with one product only. -You may define the work operation or step in which each component is -consumed using the field, **Consumed in Operation** under the -**Components** tab. Similarly, you can define the operation at which the -product will be produced under the **Miscellaneous** tab using the field -**Produced at Operation**. If this field is left blank, the products -will be consumed/produced at the final operation in the routing. +This feature will help optimize your manufacturing process while saving +you time. -.. image:: media/bill_configuration01.png +Setting up a BoM +================ + +You can use BoMs without routings. You will use this if you choose to +manage your manufacturing operations using manufacturing orders only. In +other words, you choose to realize your manufacturing process in one +step and do not track the steps the product goes through. + +Before creating your *BoM*, you have to create the product using the +*BoM* and, at least, one of the components. Go to the *Master Data* +menu > *Products* and create both the finished product and the +component. + +Once done, go to the *Bills of Materials* menu under *Master Data*. +Now, create it. Choose the product from the dropdown menu and add your +components and the quantity. In this case, keep the default *BoM* +type, which is *Manufacture this Product*. + +.. image:: media/bills_of_materials_01.png :align: center -Adding Byproducts to a BoM -========================== +Using the same BoM to describe Variants +--------------------------------------- -In Odoo, a byproduct is any product produced by a BoM in addition to the -primary product. +As said above, you can use *BoM* for *Product Variants*. It is +basically the same as for the standard product. -To add byproducts to a BoM, you will first need to enable them from -:menuselection:`Configuration --> Settings`. +If your *BoM* is for one variant only, then specify which one in the +*Product Variant* field. If not, specify the variant it is consumed +for on each component line. You can add several variants for each +component. -.. image:: media/bill_configuration02.png +.. image:: media/bills_of_materials_02.png :align: center -Once byproducts are enabled, you can add them to your bills of materials -under the **Byproducts** tab of the bill of materials. You can add -any product or products as byproducts. Byproducts are produced in the -same step of the routing as the primary product of the BoM. +Adding a routing +================ -.. image:: media/bill_configuration03.png +You can add routing to your *BoM*. You will do this if you need to +define a series of operations required by your manufacturing process. To +use it, enable the *Work Orders* feature in the *Manufacturing* app +settings. + +.. image:: media/bills_of_materials_03.png :align: center -Setting up a BoM for a Product With Sub-Assemblies -================================================== +.. note:: + Each *BoM* can have only one routing while each routing can be used + multiple times. -A subassembly is a manufactured product which is intended to be used as -a component of another manufactured product. You may wish to employ -sub-assemblies to simplify a complex BoM, to more accurately represent -your manufacturing flow, or to use the same subassembly in multiple -BoMs. A BoM that employs subassemblies is often referred to as a -multi-level BoM. +Now that you have created your routing, add it to your *BoM*. You can +select when, in the work operations, your components are consumed with +the dropdown menu. -Multi-level bills of materials in Odoo are accomplished by creating a -top-level BoM and subassembly BoMs. Next, the procurement route of the -subassembly product is defined. This ensures that every time a -manufacturing order for the top-level product is created, a -manufacturing order for each subassembly is created as well. - -Configure the Top-Level Product BoM ------------------------------------ - -To configure a multi-level BoM, create the top-level product and its -BoM. Include any subassemblies in the list of components. Create a BoM -for each subassembly as you would for any product. - -.. image:: media/bill_configuration04.png +.. image:: media/bills_of_materials_04.png :align: center -Configure the Subassembly Product Data --------------------------------------- +Adding By-Products +================== -On the product form of the subassembly, you must select the routes -**Manufacture** and **Make To Order**. The **Manufacture** -route takes precedence over the **Buy** route, so selecting the -latter will have no effect. +In Odoo, a *by-product* is any product produced by a *BoM* in +addition to the primary product. -.. image:: media/bill_configuration05.png +To add *by-products* to a *BoM*, you will first need to enable them +from the *Manufacturing* app settings. + +.. image:: media/bills_of_materials_05.png :align: center -If you would like to be able to purchase the subassembly in addition to -manufacturing it, select **Can be Purchased**. All other fields on -the subassembly product form may be configured according to your -preference. +Once the feature is enabled, you can add your *By-Products* to your +*BoMs*. You can add as many *By-Products* as you want. Just keep in +mind that you need to register during which operation your by-product is +produced. -Using a Single BoM to Describe Several Variants of a Single Product -=================================================================== - -Odoo allows you to use one bill of materials for multiple variants of -the same product. Simply enable variants from -:menuselection:`Configuration --> Settings`. - -.. image:: media/bill_configuration06.png - :align: center - -You will then be able to specify which component lines are to be used in -the manufacture of each product variant. You may specify multiple -variants for each line. If no variant is specified, the line will be -used for all variants. - -When defining variant BoMs on a line-item-basis, the **Product -Variant** field in the main section of the BoM should be left blank. -This field is used when creating a BoM for one variant of a product -only. - -.. image:: media/bill_configuration07.png - :align: center +.. image:: media/bills_of_materials_06.png + :align: center \ No newline at end of file diff --git a/manufacturing/management/flexible_components_consumption.rst b/manufacturing/management/flexible_components_consumption.rst new file mode 100644 index 000000000..d5d0e62ec --- /dev/null +++ b/manufacturing/management/flexible_components_consumption.rst @@ -0,0 +1,53 @@ +=================================== +Use flexible components consumption +=================================== + +Sometimes, you might need more components than usual to manufacture a +product. Let’s say that you produce a desk combination of 4 desks and +two chairs but your customer asks you one more desk. Alright, you can do +that. But you will need to register it! + +In case this happens, Odoo has the *flexible components consumption* +feature available. If you enable it, you will be able to consume as many +components as needed and it will make you save time in the registration +of your items consumption. + +Configuration +============= + +Using flexible component consumption is easy and can be done in a few +steps. All you need is a *BoM* and a *Quality Control Point*. +Therefore, you will need to activate the feature *Quality* in the +*MRP* app settings. + +First, open the *BoM* you want to use for flexible component +consumption and edit it. In the *Miscellaneous* tab, choose +*Flexible* as the consumption type. Then, save. + +.. image:: media/flexible_components_consumption_01.png + :align: center + +Now, in the *Quality* app, open the *Control Point* menu, under +*Quality Control* and create a new *Quality Control Point*. Choose +your product, your operation and work order operation. Then, choose +*Register Consumed Materials* as type. + +.. image:: media/flexible_components_consumption_02.png + :align: center + +Next, go back to your *Manufacturing* app and create a *Manufacturing +order*. Choose the product for which you have created the flexible +*BoM*. + +Then, confirm it and launch the process step. While processing, you will +have the possibility to consume more components than expected in the +*BoM*. To do so, click on *Continue Consumption*. + +.. image:: media/flexible_components_consumption_03.png + :align: center + +When the job is over, you will find a summary of your component +consumption in the *Finished Steps* tab of your work order. + +.. image:: media/flexible_components_consumption_04.png + :align: center \ No newline at end of file diff --git a/manufacturing/management/kit_shipping.rst b/manufacturing/management/kit_shipping.rst index cbfa2f87d..6bea8448b 100644 --- a/manufacturing/management/kit_shipping.rst +++ b/manufacturing/management/kit_shipping.rst @@ -1,80 +1,81 @@ -====================================== -How to Sell a Set of Products as a Kit -====================================== +============================= +Sell sets of products as kits +============================= A *kit* is a set of components that are delivered without first being -assembled or mixed. Kits are described in Odoo using *bills of -materials*. There are two basic ways to configure kits, depending on -how stock of the kit product is to be managed. In either case, both the -Inventory and Manufacturing apps must be installed. +assembled or mixed. *Kits* are described in Odoo using *Bills of +Materials*. There are two basic ways to configure *kits*, depending +on how the stock of the kit product is to be managed. In either case, +both the *Inventory* and *Manufacturing* apps must be installed. Manage Stock of Component Products ================================== -If you would like to assemble kits as they are ordered, managing stock -of the kit *components* only, you will use a Kit BoM without a -manufacturing step. +If you want to assemble kits as they are ordered, managing stock of the +kit components only, you will use a *Kit BoM* without a manufacturing +step. -A product using a Kit BoM will appear as a single line item on a +A product using a *Kit BoM* will appear as a single line item on a quotation and sales order, but will generate a delivery order with one line item for each of the components of the kit. In the examples below, -the image at left shows a sales order for the kit "Custom Computer Kit", -while the image at right shows the corresponding delivery order. +the first image shows a sales order for the kit *Custom Computer Kit*, +while the second image shows the corresponding delivery order. -|image0|\ |image1| - -Configuration -------------- - -From the **Products** menu in either the Inventory or Manufacturing -app, create each component product as you would any other product, then -create the top-level, or kit product. The kit product should have only -the route **Manufacture** set. Because you cannot track the stock of -kit products, the Product Type should be set to **Consumable**. -Because a kit product cannot be purchased, **Can be Purchased** -should be unchecked. - -All other parameters on the kit product may be modified according to -your preference. The component products require no special -configuration. - -.. image:: media/kit_shipping03.png +.. image:: media/kit_shipping_01.png :align: center -Once the products are configured, create a bill of materials for the kit -product. Add each component and its quantity. Select the BoM Type -**Ship this product as a set of components**. All other options may -be left with their default values. +.. image:: media/kit_shipping_02.png + :align: center -.. image:: media/kit_shipping04.png +Configuration +============= + +From the *Products menu* in either the *Inventory* or +*Manufacturing* app, create each component product as you would with +any other product, then create the top-level, or kit product. The kit +product should have only the *route Manufacture* set, in the +*Inventory tab*. Because you cannot track the stock of kit products, +the *Product Type* should be set to Consumable. Because a kit product +cannot be purchased, then, *Can be Purchased* should be unchecked. + +All other parameters on the kit product may be modified according to +your preference. The component products require no particular +configuration. + +.. image:: media/kit_shipping_03.png + :align: center + +Once the products are configured, create a *bill of materials* for the +kit product. Add each component and its quantity. Select the *BoM Type +Ship this product as a set of components*. All other options may be +left with their default values. + +.. image:: media/kit_shipping_04.png :align: center Manage Stock of Kit Product and Component Products ================================================== -If you would like to manage stock of the top-level kit product, you will -use a standard BoM with a manufacturing step instead of a Kit BoM. When -using a standard BoM to assemble kits, a manufacturing order will be -created. The manufacturing order must be registered as completed before -the kit product will appear in your stock. +If you want to manage stock of the *top-level kit product*, you will +use a standard *BoM* with a manufacturing step instead of a *Kit +BoM*. When using a standard BoM to assemble kits, a *manufacturing +order* will be created. The *manufacturing order* must be registered +as completed before the kit product will appear in your stock. Configuration -------------- +============= -On the kit product, select the route **Manufacture**. You may also -select **Make to Order**, which will create a manufacturing order -whenever a sales order is confirmed. Select the product type -**Stockable Product** to enable stock management. +On the kit product, select the *route Manufacture*. You may also +select *Make to Order*, which will create a *manufacturing order* +whenever a sales order is confirmed. Select the product type *Storable +Product* to enable stock management. -.. image:: media/kit_shipping05.png +.. image:: media/kit_shipping_05.png :align: center -When you create the bill of materials, select the BoM Type -**Manufacture this product**. The assembly of the kit will be -described by a manufacturing order rather than a packing operation. +When you create the *bill of materials*, select the BoM Type +*Manufacture this product*. The assembly of the kit will be described +by a *manufacturing order* rather than a packing operation. -.. image:: media/kit_shipping06.png - :align: center - -.. |image0| image:: ./media/kit_shipping01.png -.. |image1| image:: ./media/kit_shipping02.png +.. image:: media/kit_shipping_06.png + :align: center \ No newline at end of file diff --git a/manufacturing/management/manufacturing_order.rst b/manufacturing/management/manufacturing_order.rst index f176467bc..069206eb3 100644 --- a/manufacturing/management/manufacturing_order.rst +++ b/manufacturing/management/manufacturing_order.rst @@ -1,56 +1,75 @@ -==================================== -How to process a manufacturing order -==================================== +============================ +Process Manufacturing Orders +============================ -Introduction -============ +In Odoo, you can manage your manufacturing process in two different +ways. You can work with one document, or decide to have more information +and control over it. -There are two basic ways to manage manufacturing in Odoo. The first way -manages work with one document only. This document is the -**manufacturing order**. The second way uses additional documents to -give you more precise control over the manufacturing process. In this -way, **Manufacturing orders** are divided into one or more steps -defined by **work orders**, performed in an order defined by -**routings**. +In the first case, Odoo makes things easier and helps you manage work +with one document only: the manufacturing order. No complex steps during +the process, you just have to schedule the job and record the +production. -How to manage manufacturing without routings -============================================ +But, if you need more control, you can use additional documents (steps) +to your manufacturing process. This way, *Manufacturing Orders* are +divided into one or more steps defined by *Work Orders* and performed +in a sequence defined by *routings*. -You will most likely use manufacturing orders without routings if all -the work to produce your product is performed in one place, by one -person, in one step, and/or you do not need the level of granular -control afforded by work orders and routings. +Using Odoo will allow you to precisely schedule the job, analyze your +efficiency but also have ease when realizing each step of your +manufacturing process. -Managing your operations in this way is the default behavior in Odoo. -There are two basic phases from planning to production: +Manage Manufacturing Without Routings +===================================== -1. Create manufacturing orders +If your manufacturing process is limited to one place, one person and +one step, you will probably use manufacturing orders without routings. -2. Record Production +In Odoo, it is the default behavior. If work this way, there are two +basic phases from planning to production: -How to manage manufacturing with routings and work orders -========================================================= +- Create a manufacturing order -To use work orders and routings, you will need to enable the option -**Manage production by work orders** From -:menuselection:`Configuration --> Settings`. You will then be able to add -routings to bills of materials, and configure some additional related -fields. You will also be able to create **work centers**, the +- Record the production + +Manage Manufacturing with Routings and Work Centers +=================================================== + +To use *Work Centers* and *Routings*, you will need to enable the +*Work Orders* feature. To do so, go to the *Manufacturing* app +settings. + +.. image:: media/process_manufacturing_orders_01.png + :align: center + +Now, you can add routings to *BoMs* and configure your operations +taking place at different *work centers*. The *Work Centers* are the locations at which work orders are performed. -When manufacturing with routings and work orders, each work order is -scheduled individually. You will also have access to time and capacity -planning, and reports on costing and efficiency on a work center level. +.. image:: media/process_manufacturing_orders_02.png + :align: center -Manufacturing using routings can be broken down into several steps. When -configuring your BoM, you will need to add a routing defining the -component work orders. After planning the manufacturing order, you will -have the added step of scheduling work orders. +When manufacturing this way, each *Work Order* is scheduled +individually. You will also have access to time and capacity planning, +as well as reports on costing and efficiency for each *Work Center*. -The workflow is thus divided into three basic phases, as follows: +.. image:: media/process_manufacturing_orders_03.png + :align: center -1. Create manufacturing orders +Thus, the workflow is divided into three basic phases: -2. Schedule the associated work orders. +- Create the manufacturing order -3. Perform the scheduled work and record production. +.. image:: media/process_manufacturing_orders_04.png + :align: center + +- Schedule the associated work orders + +.. image:: media/process_manufacturing_orders_05.png + :align: center + +- Perform the scheduled work and record production + +.. image:: media/process_manufacturing_orders_06.png + :align: center \ No newline at end of file diff --git a/manufacturing/management/media/alternative_wc_01.png b/manufacturing/management/media/alternative_wc_01.png new file mode 100644 index 000000000..222482e10 Binary files /dev/null and b/manufacturing/management/media/alternative_wc_01.png differ diff --git a/manufacturing/management/media/alternative_wc_02.png b/manufacturing/management/media/alternative_wc_02.png new file mode 100644 index 000000000..6d2f6124a Binary files /dev/null and b/manufacturing/management/media/alternative_wc_02.png differ diff --git a/manufacturing/management/media/alternative_wc_03.png b/manufacturing/management/media/alternative_wc_03.png new file mode 100644 index 000000000..174b57be0 Binary files /dev/null and b/manufacturing/management/media/alternative_wc_03.png differ diff --git a/manufacturing/management/media/alternative_wc_04.png b/manufacturing/management/media/alternative_wc_04.png new file mode 100644 index 000000000..d421668e8 Binary files /dev/null and b/manufacturing/management/media/alternative_wc_04.png differ diff --git a/manufacturing/management/media/alternative_wc_05.png b/manufacturing/management/media/alternative_wc_05.png new file mode 100644 index 000000000..c08f0c142 Binary files /dev/null and b/manufacturing/management/media/alternative_wc_05.png differ diff --git a/manufacturing/management/media/alternative_wc_06.png b/manufacturing/management/media/alternative_wc_06.png new file mode 100644 index 000000000..a9e051dca Binary files /dev/null and b/manufacturing/management/media/alternative_wc_06.png differ diff --git a/manufacturing/management/media/bills_of_materials_01.png b/manufacturing/management/media/bills_of_materials_01.png new file mode 100644 index 000000000..6f39fa24e Binary files /dev/null and b/manufacturing/management/media/bills_of_materials_01.png differ diff --git a/manufacturing/management/media/bills_of_materials_02.png b/manufacturing/management/media/bills_of_materials_02.png new file mode 100644 index 000000000..c6cf433e0 Binary files /dev/null and b/manufacturing/management/media/bills_of_materials_02.png differ diff --git a/manufacturing/management/media/bills_of_materials_03.png b/manufacturing/management/media/bills_of_materials_03.png new file mode 100644 index 000000000..a45940329 Binary files /dev/null and b/manufacturing/management/media/bills_of_materials_03.png differ diff --git a/manufacturing/management/media/bills_of_materials_04.png b/manufacturing/management/media/bills_of_materials_04.png new file mode 100644 index 000000000..8a1bebfcf Binary files /dev/null and b/manufacturing/management/media/bills_of_materials_04.png differ diff --git a/manufacturing/management/media/bills_of_materials_05.png b/manufacturing/management/media/bills_of_materials_05.png new file mode 100644 index 000000000..0eca7f970 Binary files /dev/null and b/manufacturing/management/media/bills_of_materials_05.png differ diff --git a/manufacturing/management/media/bills_of_materials_06.png b/manufacturing/management/media/bills_of_materials_06.png new file mode 100644 index 000000000..2fcc8684c Binary files /dev/null and b/manufacturing/management/media/bills_of_materials_06.png differ diff --git a/manufacturing/management/media/flexible_components_consumption_01.png b/manufacturing/management/media/flexible_components_consumption_01.png new file mode 100644 index 000000000..4e0de6f5e Binary files /dev/null and b/manufacturing/management/media/flexible_components_consumption_01.png differ diff --git a/manufacturing/management/media/flexible_components_consumption_02.png b/manufacturing/management/media/flexible_components_consumption_02.png new file mode 100644 index 000000000..4ce18f018 Binary files /dev/null and b/manufacturing/management/media/flexible_components_consumption_02.png differ diff --git a/manufacturing/management/media/flexible_components_consumption_03.png b/manufacturing/management/media/flexible_components_consumption_03.png new file mode 100644 index 000000000..dd4d2eacd Binary files /dev/null and b/manufacturing/management/media/flexible_components_consumption_03.png differ diff --git a/manufacturing/management/media/flexible_components_consumption_04.png b/manufacturing/management/media/flexible_components_consumption_04.png new file mode 100644 index 000000000..7ad894269 Binary files /dev/null and b/manufacturing/management/media/flexible_components_consumption_04.png differ diff --git a/manufacturing/management/media/kit_shipping01.png b/manufacturing/management/media/kit_shipping01.png deleted file mode 100644 index b9cbd30d8..000000000 Binary files a/manufacturing/management/media/kit_shipping01.png and /dev/null differ diff --git a/manufacturing/management/media/kit_shipping02.png b/manufacturing/management/media/kit_shipping02.png deleted file mode 100644 index 805708fa1..000000000 Binary files a/manufacturing/management/media/kit_shipping02.png and /dev/null differ diff --git a/manufacturing/management/media/kit_shipping03.png b/manufacturing/management/media/kit_shipping03.png deleted file mode 100644 index 19d01f6af..000000000 Binary files a/manufacturing/management/media/kit_shipping03.png and /dev/null differ diff --git a/manufacturing/management/media/kit_shipping04.png b/manufacturing/management/media/kit_shipping04.png deleted file mode 100644 index 4744aa440..000000000 Binary files a/manufacturing/management/media/kit_shipping04.png and /dev/null differ diff --git a/manufacturing/management/media/kit_shipping05.png b/manufacturing/management/media/kit_shipping05.png deleted file mode 100644 index 72f51b282..000000000 Binary files a/manufacturing/management/media/kit_shipping05.png and /dev/null differ diff --git a/manufacturing/management/media/kit_shipping06.png b/manufacturing/management/media/kit_shipping06.png deleted file mode 100644 index 94c473eff..000000000 Binary files a/manufacturing/management/media/kit_shipping06.png and /dev/null differ diff --git a/manufacturing/management/media/kit_shipping_01.png b/manufacturing/management/media/kit_shipping_01.png new file mode 100644 index 000000000..915082f45 Binary files /dev/null and b/manufacturing/management/media/kit_shipping_01.png differ diff --git a/manufacturing/management/media/kit_shipping_02.png b/manufacturing/management/media/kit_shipping_02.png new file mode 100644 index 000000000..4bd279217 Binary files /dev/null and b/manufacturing/management/media/kit_shipping_02.png differ diff --git a/manufacturing/management/media/kit_shipping_03.png b/manufacturing/management/media/kit_shipping_03.png new file mode 100644 index 000000000..88ad9c463 Binary files /dev/null and b/manufacturing/management/media/kit_shipping_03.png differ diff --git a/manufacturing/management/media/kit_shipping_04.png b/manufacturing/management/media/kit_shipping_04.png new file mode 100644 index 000000000..d02985af6 Binary files /dev/null and b/manufacturing/management/media/kit_shipping_04.png differ diff --git a/manufacturing/management/media/kit_shipping_05.png b/manufacturing/management/media/kit_shipping_05.png new file mode 100644 index 000000000..fc5dfb2a9 Binary files /dev/null and b/manufacturing/management/media/kit_shipping_05.png differ diff --git a/manufacturing/management/media/kit_shipping_06.png b/manufacturing/management/media/kit_shipping_06.png new file mode 100644 index 000000000..377264309 Binary files /dev/null and b/manufacturing/management/media/kit_shipping_06.png differ diff --git a/manufacturing/management/media/plan_work_order_01.png b/manufacturing/management/media/plan_work_order_01.png new file mode 100644 index 000000000..2e0bbf629 Binary files /dev/null and b/manufacturing/management/media/plan_work_order_01.png differ diff --git a/manufacturing/management/media/plan_work_order_02.png b/manufacturing/management/media/plan_work_order_02.png new file mode 100644 index 000000000..fc62834b7 Binary files /dev/null and b/manufacturing/management/media/plan_work_order_02.png differ diff --git a/manufacturing/management/media/plan_work_order_03.png b/manufacturing/management/media/plan_work_order_03.png new file mode 100644 index 000000000..66d596b43 Binary files /dev/null and b/manufacturing/management/media/plan_work_order_03.png differ diff --git a/manufacturing/management/media/plan_work_order_04.png b/manufacturing/management/media/plan_work_order_04.png new file mode 100644 index 000000000..3cbff845c Binary files /dev/null and b/manufacturing/management/media/plan_work_order_04.png differ diff --git a/manufacturing/management/media/process_manufacturing_orders_01.png b/manufacturing/management/media/process_manufacturing_orders_01.png new file mode 100644 index 000000000..a45940329 Binary files /dev/null and b/manufacturing/management/media/process_manufacturing_orders_01.png differ diff --git a/manufacturing/management/media/process_manufacturing_orders_02.png b/manufacturing/management/media/process_manufacturing_orders_02.png new file mode 100644 index 000000000..0ef83871e Binary files /dev/null and b/manufacturing/management/media/process_manufacturing_orders_02.png differ diff --git a/manufacturing/management/media/process_manufacturing_orders_03.png b/manufacturing/management/media/process_manufacturing_orders_03.png new file mode 100644 index 000000000..67173557f Binary files /dev/null and b/manufacturing/management/media/process_manufacturing_orders_03.png differ diff --git a/manufacturing/management/media/process_manufacturing_orders_04.png b/manufacturing/management/media/process_manufacturing_orders_04.png new file mode 100644 index 000000000..a1e397336 Binary files /dev/null and b/manufacturing/management/media/process_manufacturing_orders_04.png differ diff --git a/manufacturing/management/media/process_manufacturing_orders_05.png b/manufacturing/management/media/process_manufacturing_orders_05.png new file mode 100644 index 000000000..d41a95e81 Binary files /dev/null and b/manufacturing/management/media/process_manufacturing_orders_05.png differ diff --git a/manufacturing/management/media/process_manufacturing_orders_06.png b/manufacturing/management/media/process_manufacturing_orders_06.png new file mode 100644 index 000000000..4b5941b58 Binary files /dev/null and b/manufacturing/management/media/process_manufacturing_orders_06.png differ diff --git a/manufacturing/management/media/semi-finished_products_01.png b/manufacturing/management/media/semi-finished_products_01.png new file mode 100644 index 000000000..879727b47 Binary files /dev/null and b/manufacturing/management/media/semi-finished_products_01.png differ diff --git a/manufacturing/management/media/semi-finished_products_02.png b/manufacturing/management/media/semi-finished_products_02.png new file mode 100644 index 000000000..c6059eb6a Binary files /dev/null and b/manufacturing/management/media/semi-finished_products_02.png differ diff --git a/manufacturing/management/media/semi-finished_products_03.png b/manufacturing/management/media/semi-finished_products_03.png new file mode 100644 index 000000000..79807eba3 Binary files /dev/null and b/manufacturing/management/media/semi-finished_products_03.png differ diff --git a/manufacturing/management/media/semi-finished_products_04.png b/manufacturing/management/media/semi-finished_products_04.png new file mode 100644 index 000000000..d6faeac1c Binary files /dev/null and b/manufacturing/management/media/semi-finished_products_04.png differ diff --git a/manufacturing/management/media/subcontracting01.png b/manufacturing/management/media/subcontract_01.png similarity index 100% rename from manufacturing/management/media/subcontracting01.png rename to manufacturing/management/media/subcontract_01.png diff --git a/manufacturing/management/media/subcontracting02.png b/manufacturing/management/media/subcontract_02.png similarity index 100% rename from manufacturing/management/media/subcontracting02.png rename to manufacturing/management/media/subcontract_02.png diff --git a/manufacturing/management/media/subcontracting03.png b/manufacturing/management/media/subcontract_03.png similarity index 100% rename from manufacturing/management/media/subcontracting03.png rename to manufacturing/management/media/subcontract_03.png diff --git a/manufacturing/management/media/subcontracting04.png b/manufacturing/management/media/subcontract_04.png similarity index 100% rename from manufacturing/management/media/subcontracting04.png rename to manufacturing/management/media/subcontract_04.png diff --git a/manufacturing/management/media/subcontracting05.png b/manufacturing/management/media/subcontract_05.png similarity index 100% rename from manufacturing/management/media/subcontracting05.png rename to manufacturing/management/media/subcontract_05.png diff --git a/manufacturing/management/media/subcontracting06.png b/manufacturing/management/media/subcontract_06.png similarity index 100% rename from manufacturing/management/media/subcontracting06.png rename to manufacturing/management/media/subcontract_06.png diff --git a/manufacturing/management/media/subcontracting07.png b/manufacturing/management/media/subcontract_07.png similarity index 100% rename from manufacturing/management/media/subcontracting07.png rename to manufacturing/management/media/subcontract_07.png diff --git a/manufacturing/management/media/subcontracting08.png b/manufacturing/management/media/subcontract_08.png similarity index 100% rename from manufacturing/management/media/subcontracting08.png rename to manufacturing/management/media/subcontract_08.png diff --git a/manufacturing/management/media/use_mps_01.png b/manufacturing/management/media/use_mps_01.png new file mode 100644 index 000000000..76b708312 Binary files /dev/null and b/manufacturing/management/media/use_mps_01.png differ diff --git a/manufacturing/management/media/use_mps_02.png b/manufacturing/management/media/use_mps_02.png new file mode 100644 index 000000000..c5f88c273 Binary files /dev/null and b/manufacturing/management/media/use_mps_02.png differ diff --git a/manufacturing/management/media/use_mps_03.png b/manufacturing/management/media/use_mps_03.png new file mode 100644 index 000000000..d24643308 Binary files /dev/null and b/manufacturing/management/media/use_mps_03.png differ diff --git a/manufacturing/management/media/use_mps_04.png b/manufacturing/management/media/use_mps_04.png new file mode 100644 index 000000000..3cdb0921b Binary files /dev/null and b/manufacturing/management/media/use_mps_04.png differ diff --git a/manufacturing/management/media/use_mps_05.png b/manufacturing/management/media/use_mps_05.png new file mode 100644 index 000000000..db6452e9c Binary files /dev/null and b/manufacturing/management/media/use_mps_05.png differ diff --git a/manufacturing/management/media/use_mps_06.png b/manufacturing/management/media/use_mps_06.png new file mode 100644 index 000000000..8b8d349e6 Binary files /dev/null and b/manufacturing/management/media/use_mps_06.png differ diff --git a/manufacturing/management/media/use_mps_07.png b/manufacturing/management/media/use_mps_07.png new file mode 100644 index 000000000..836ff2179 Binary files /dev/null and b/manufacturing/management/media/use_mps_07.png differ diff --git a/manufacturing/management/media/use_mps_08.png b/manufacturing/management/media/use_mps_08.png new file mode 100644 index 000000000..3525471b7 Binary files /dev/null and b/manufacturing/management/media/use_mps_08.png differ diff --git a/manufacturing/management/media/use_mps_09.png b/manufacturing/management/media/use_mps_09.png new file mode 100644 index 000000000..584903ee2 Binary files /dev/null and b/manufacturing/management/media/use_mps_09.png differ diff --git a/manufacturing/management/plan_work_orders.rst b/manufacturing/management/plan_work_orders.rst new file mode 100644 index 000000000..d011bdd18 --- /dev/null +++ b/manufacturing/management/plan_work_orders.rst @@ -0,0 +1,52 @@ +================ +Plan Work Orders +================ + +In some cases, companies need to schedule their work orders. Doing so, +they can organize the work for the whole day and be sure everything goes +well. It helps to avoid scheduling multiple work orders at the same time +when you don’t have the capacity to do so. + +With Odoo, companies can schedule the planned start date for their +manufacturing orders. No possible duplication, no potential issues with +the planning. And, if you plan two work orders at the same work center, +at the same hour, the second one will be scheduled right after the first +one, avoiding work superposition. + +Create the Work Orders +====================== + +The first thing you need to do is to open the *Manufacturing* app. +Then, Go to the settings and enable the *Work Orders* feature. + +.. image:: media/plan_work_order_01.png + :align: center + +Now, go to the *Manufacturing Orders* menu and hit *Create*. Choose +your product and add a *Planned Start Date*. + +.. image:: media/plan_work_order_02.png + :align: center + +.. note:: + The “Deadline Start” field is informative. It shows you until when you + can launch the manufacturing order to fulfill the initial demand. + +Mark your *Manufacturing Order* as todo and plan it. By going to the +*Planning* menu, you can access to the scheduled orders. Here is the +one we just created: + +.. image:: media/plan_work_order_03.png + :align: center + +.. note:: + If you plan two work orders at the same hour, the second one will be + scheduled after the first one if the jobs need to be done at the same + work center. The start date will, then, be automatically updated + considering the first free slot on the work center. + +If you overrun the planned date and begin the job later, you will have a +track of it in the *Time Tracking* tab of your work order. + +.. image:: media/plan_work_order_04.png + :align: center \ No newline at end of file diff --git a/manufacturing/management/sub_assemblies.rst b/manufacturing/management/sub_assemblies.rst index 74e3e0862..5a633a6bf 100644 --- a/manufacturing/management/sub_assemblies.rst +++ b/manufacturing/management/sub_assemblies.rst @@ -1,42 +1,49 @@ -==================================== -How to manage semi-finished products -==================================== +============================= +Manage semi-finished products +============================= -A subassembly is a manufactured product which is intended to be used as -a component of another manufactured product. You may wish to employ -sub-assemblies to simplify a complex BoM, to more accurately represent -your manufacturing flow, or to use the same subassembly in multiple -BoMs. A BoM that employs subassemblies is often referred to as a -multi-level BoM. +In Odoo, you can use subassembly products to simplify a complex *Bill +of Materials* or to represent your manufacturing flow more accurately. +A *subassembly product* is a manufactured product that is used as a +component to make another one. -Multi-level bills of materials in Odoo are accomplished by creating a -top-level BoM and subassembly BoMs. Next, the procurement route of the -subassembly product is defined. This ensures that every time a -manufacturing order for the top-level product is created, a -manufacturing order for each subassembly is created as well. +A *BoM* that employs *subassemblies* is referred to as a multi-level +BoM. Those are accomplished by creating a *top-level BoM* and +*subassembly ones*. This process requires a route that will ensure +that every time a manufacturing order for the top-level product is +created, another one will be for subassemblies. -Configure the Top -Level Product BoM ------------------------------------- +Configure the Subassembly Product +================================= -To configure a multi-level BoM, create the top-level product and its -BoM. Include any subassemblies in the list of components. Create a BoM -for each subassembly as you would for any product. +To configure a *multi-level BoM*, you will need a top-level product +but also its subassemblies. The first step is to create a product form +for each of the subassemblies. Select the routes *Manufacture* and +*Replenish on Order*. Now, hit save. -.. image:: media/sub_assemblies01.png +.. image:: media/semi-finished_products_01.png :align: center -Configure the Subassembly Product Data --------------------------------------- +In the *Bill of Materials* menu, under *Master Data*, create a new +*Bill of Materials*. Choose the product you just created and add its +components. -On the product form of the subassembly, you must select the routes -**Manufacture** and **Make To Order**. The **Manufacture** -route takes precedence over the **Buy** route, so selecting the -latter will have no effect. - -.. image:: media/sub_assemblies02.png +.. image:: media/semi-finished_products_02.png :align: center -If you would like to be able to purchase the subassembly in addition to -manufacturing it, select **Can be Purchased**. All other fields on -the subassembly product form may be configured according to your -preference. +Configure the Main BoM +====================== + +Now, you can configure the top-level product and its *BoM*. Include +any subassemblies in the list of components. + +.. image:: media/semi-finished_products_03.png + :align: center + +Now, each time you will plan a manufacturing order for the top-level +product, a manufacturing order will be created for the subassembly one. +Then, you will have to manufacture the subassembly in order to make it +available before manufacturing the finished product. + +.. image:: media/semi-finished_products_04.png + :align: center \ No newline at end of file diff --git a/manufacturing/management/subcontracting.rst b/manufacturing/management/subcontracting.rst index eac5e9904..9eb0e0c4c 100644 --- a/manufacturing/management/subcontracting.rst +++ b/manufacturing/management/subcontracting.rst @@ -1,29 +1,35 @@ -Subcontract the manufacturing of some products -============================================== +============================= +Subcontract the manufacturing +============================= -Some business subcontract the production of some finished products +Some businesses subcontract the production of some finished products through subcontractors. This can be easily managed through Odoo. Configuration -------------- +============= -Go in the :menuselection:`Manufacturing --> Configuration --> Settings` and tick the box *Subcontracting*. +Go to the *Manufacturing app > Configuration > Settings* and tick the +box *Subcontracting*. -.. image:: media/subcontracting01.png +.. image:: media/subcontract_01.png :align: center You can now define subcontractors contacts. When you purchase or receive products from a contact of type subcontractor, the correct stock moves are created to represent the subcontracting of the production. -.. image:: media/subcontracting02.png +.. image:: media/subcontract_02.png :align: center -The next step is to create a Bill of Material of type *subcontracted*. -In this BoM, list the components you need to supply to the -subcontractor. +.. tip:: + You can set the subcontractor as a vendor in case you plan to buy him + the subcontracted products via purchase orders. -.. image:: media/subcontracting03.png +The next step is to create a *Bill of Material* of type +*subcontracted*. In this *BoM*, list the components you need to +supply to the subcontractor. + +.. image:: media/subcontract_03.png :align: center You can also define subcontractors on the BoM. @@ -32,76 +38,77 @@ You can also define subcontractors on the BoM. - If some are set, the BoM can only be used for those subcontractors -.. image:: media/subcontracting04.png +.. image:: media/subcontract_04.png :align: center -The configuration part is already done! - Receive or buy a subcontracted product --------------------------------------- +====================================== -You have two options to trigger a the subcontracting of a product: +You have two options to trigger the subcontracting of a product: -- Option A: You can buy the subcontracted product from your +- **Option A**: You can buy the subcontracted product from your subcontractor -- Option B: You can directly receive the subcontracted product +- **Option B**: You can directly receive the subcontracted product Let’s start with option A (option B is just a simpler version of it). Create a new purchase order. The vendor must be a subcontractor. The unit price should be the cost you are paying to the subcontractor for -the subcontracting (it’s thus not necessarily the total cost of the +the subcontracting (thus, it’s not necessarily the total cost of the subcontracted product). -.. image:: media/subcontracting05.png +.. image:: media/subcontract_05.png :align: center -The validation of the purchase order creates automatically the receipt. +The validation of the purchase order automatically creates the receipt. Whenever you receive the product, you can validate the receipt. The following stock moves are created: - For the components - From Subcontracting To Production + - From Subcontracting To Production - For the subcontracted product - From Production to Subcontracting + - From Production to Subcontracting - From Subcontracting to Stock + - From Subcontracting to Stock The *Subcontracting Location* represents the place where the products are at your subcontractor’s warehouse. It is configured as an internal location, the components that are sent to the subcontractor are still valued in your stock. -For option B, you simply can create the receipt manually with a partner +For option B, you can simply create the receipt manually with a partner of type subcontractor defined on it. Resupply the subcontractor with the components ----------------------------------------------- +============================================== There are 3 ways to manage the resupply of your subcontractor with the components: -- Manually. You simply create a delivery order on which you set the - subcontractor as partner and you choose the components to deliver +- **Manually**: You create a delivery order in which you set the + subcontractor as a partner and you choose the components to + deliver. -.. image:: media/subcontracting06.png +.. image:: media/subcontract_06.png :align: center -- With reordering rules. You can define a reordering rule on the - Subcontracting location to ensure that they are always enough - components send to your subcontractors. +- **With reordering rules**: You can define a *reordering rule* + on the *Subcontracting location* to ensure that they are always + enough components sent to your subcontractors. When the + reordering rule is triggered, a delivery order is created for the + product is automatically created. -.. image:: media/subcontracting07.png +.. image:: media/subcontract_07.png :align: center -- On order. You can also deliver the components to your subcontractors - each time you order a subcontracted product. For this, you need - to tick the route “Resupply Subcontractor on Order” on the - components concerned. +- **On order**: You can also deliver the components to your + subcontractors each time you order a subcontracted product. For + this, you need to tick the route *Resupply Subcontractor on + Order* on the wanted components. -.. image:: media/subcontracting08.png - :align: center +.. image:: media/subcontract_08.png + :align: center \ No newline at end of file diff --git a/manufacturing/management/use_mps.rst b/manufacturing/management/use_mps.rst new file mode 100644 index 000000000..74fab3e4b --- /dev/null +++ b/manufacturing/management/use_mps.rst @@ -0,0 +1,125 @@ +================================== +Use the Master Production Schedule +================================== + +The Master Production Schedule (MPS) is a valuable tool to plan your +production based on your demand forecast. + +Configuration +============= + +Go to the *Manufacturing app > Configuration > Settings* and activate +the Master Production Schedule feature before hitting save. + +.. image:: media/use_mps_01.png + :align: center + +.. tip:: + In the manufacturing settings, you can define the time range of your MPS (month/week/day) and the number of periods you want to display. + +Now, go in *Planning > Master Production Schedule* and click on add a +product. You can now define your safety stock target (= the stock you +want to have on hand at the end of the period) and the minimum and +maximum quantities to replenish. + +.. image:: media/use_mps_02.png + :align: center + +.. tip:: + The products are ordered in the MPS based on their sequence. You can + rearrange that sequence by going on the list of your products and + reorganize them with drag and drop. + +.. image:: media/use_mps_03.png + :align: center + +In the MPS view, you can decide which information you would like to show +by clicking on *rows*. Some fields can be added to the view, such as +*Actual demand*, which will show which quantity of products has +already been ordered for the period, or *Available to Promise*, which +allows you to know what can still be sold during the period (what you +plan to replenish - what is already sold during the period). You can +also decide to hide some information if it isn’t necessary. + +.. image:: media/use_mps_04.png + :align: center + +Estimate your demand and launch replenishment +============================================= + +The next step is to estimate the demand for the period. This estimation +should be entered in the row *Demand Forecast*. You can easily, at any +time, compare the demand forecast with the actual demand (= confirmed +sales). The demand forecast for a finished product will impact the +indirect demand for its components. + +.. image:: media/use_mps_05.png + :align: center + +Then, the quantity to replenish for the different periods will be +automatically computed. The replenishments you are supposed to launch +based on your lead times (vendor lead time or manufacturing lead time) +are displayed in green. You can now launch the replenishment by clicking +on the replenish button. + +Depending on the configuration of the product (buy vs. manufacture), +requests for quotations or manufacturing orders will be created. You can +easily access those by clicking on the *Actual Replenishment* cell. + +.. image:: media/use_mps_06.png + :align: center + +.. image:: media/use_mps_07.png + :align: center + +In case you manually edit the *To replenish* quantity, a small cross +will appear on the left. In case you want to go back to the +automatically computed value given by Odoo, you can click the cross. + +.. image:: media/use_mps_08.png + :align: center + +Cells color signification +========================= + +The cells, which are part of the *To replenish* line, can take +different colors depending on the situation: + +- **Green**: quantity of products which should be replenished to + reach the expected safety stock considering the demand forecast + and the indirect demand forecast. + +- **Grey**: replenishment order has already been generated, and its + quantity still matches current data. + +- **Red**: replenishment order has already been generated, and its + quantity was too high considering current data. + +- **Orange**: replenishment order has already been generated, and + its quantity was too low considering current data. + +The *Forecasted stock* line can also contain red cells, which means +the stock will be negative during the period in question. + +What if I have underestimated the demand? +----------------------------------------- + +You can still increase the demand forecast. It will impact the quantity +to replenish. The cell will become orange, and you’ll be able to launch +a new replenishment. + +What if I have overestimated the demand? +---------------------------------------- + +You can decrease the demand forecast. The cell will become red to inform +you that you’ve ordered more than planned. If you’re still able to do +it, you can cancel some RFQ or MO manually. + +What if I wrongly added a product to the MPS? +--------------------------------------------- + +You can easily remove a product from the MPS by clicking the small bin +on the right of its name. + +.. image:: media/use_mps_09.png + :align: center \ No newline at end of file diff --git a/mobile/firebase.rst b/mobile/firebase.rst index 3773aa979..5a606c597 100644 --- a/mobile/firebase.rst +++ b/mobile/firebase.rst @@ -4,76 +4,11 @@ Mobile ====== -Setup your Firebase Cloud Messaging -=================================== +Push Notifications +================== -In order to have mobile notifications in our Android app, you need an -API key. +As of Odoo 12.0, there is no more complex configuration to enable push +notifications in the mobile app. -If it is not automatically configured (for instance for On-premise or -Odoo.sh) please follow these steps below to get an API key for the -android app. - -.. danger:: - The iOS app doesn't support mobile notifications for Odoo - versions < 12. - -Firebase Settings -================= - -Create a new project --------------------- - -First, make sure you to sign in to your Google Account. Then, go to -`https://console.firebase.google.com `__ -and create a new project. - -.. image:: media/firebase01.png - :align: center - -Choose a project name, click on **Continue**, then click on **Create -project**. - -When you project is ready, click on **Continue**. - -You will be redirected to the overview project page (see next -screenshot). - -Add an app ----------- - -In the overview page, click on the Android icon. - -.. image:: media/firebase02.png - :align: center - -You must use "com.odoo.com" as Android package name. Otherwise, it will -not work. - -.. image:: media/firebase03.png - :align: center - -No need to download the config file, you can click on **Next** twice and -skip the fourth step. - -Get generated API key ---------------------- - -On the overview page, go to Project settings: - -.. image:: media/firebase04.png - :align: center - -In **Cloud Messaging**, you will see the **API key** and the **Sender ID** -that you need to set in Odoo General Settings. - -.. image:: media/firebase05.png - :align: center - -Settings in Odoo -================ - -Simply paste the API key and the Sender ID from Cloud Messaging. - -.. image:: media/firebase06.png - :align: center +Simply go to *Settings* > *General Settings* > *Odoo Cloud Notification (OCN)* +and make sure that **Push Notifications** is checked. diff --git a/mobile/media/firebase01.png b/mobile/media/firebase01.png deleted file mode 100644 index 0bcdc76c7..000000000 Binary files a/mobile/media/firebase01.png and /dev/null differ diff --git a/mobile/media/firebase02.png b/mobile/media/firebase02.png deleted file mode 100644 index 19c2afbd0..000000000 Binary files a/mobile/media/firebase02.png and /dev/null differ diff --git a/mobile/media/firebase03.png b/mobile/media/firebase03.png deleted file mode 100644 index d4e911195..000000000 Binary files a/mobile/media/firebase03.png and /dev/null differ diff --git a/mobile/media/firebase04.png b/mobile/media/firebase04.png deleted file mode 100644 index a14122a76..000000000 Binary files a/mobile/media/firebase04.png and /dev/null differ diff --git a/mobile/media/firebase05.png b/mobile/media/firebase05.png deleted file mode 100644 index b3a042eb9..000000000 Binary files a/mobile/media/firebase05.png and /dev/null differ diff --git a/mobile/media/firebase06.png b/mobile/media/firebase06.png deleted file mode 100644 index 57f527502..000000000 Binary files a/mobile/media/firebase06.png and /dev/null differ diff --git a/odoo_sh/advanced.rst b/odoo_sh/advanced.rst index abbf66ea9..a306c3db0 100644 --- a/odoo_sh/advanced.rst +++ b/odoo_sh/advanced.rst @@ -10,3 +10,4 @@ Advanced advanced/containers advanced/submodules advanced/upgrade_your_database + advanced/frequent_technical_questions diff --git a/odoo_sh/advanced/containers.rst b/odoo_sh/advanced/containers.rst index bdd3f55db..7aea9bd51 100644 --- a/odoo_sh/advanced/containers.rst +++ b/odoo_sh/advanced/containers.rst @@ -22,7 +22,7 @@ The platform will take care to install these dependencies in your containers. `The pip requirements specifiers `_ documentation can help you write a :file:`requirements.txt` file. To have a concrete example, -check out the `requirements.txt file of Odoo `_. +check out the `requirements.txt file of Odoo `_. The :file:`requirements.txt` files of submodules are taken into account as well. The platform looks for :file:`requirements.txt` files in each folder containing Odoo modules: Not in the module folder itself, @@ -78,7 +78,7 @@ Here are the Odoo.sh pertinent directories: Both Python 2.7 and 3.5 are installed in the containers. However: * If your project is configured to use Odoo 10.0, the Odoo server runs with Python 2.7. -* If your project is configured to use Odoo 11.0 or greater, the Odoo server runs with Python 3.5. +* If your project is configured to use Odoo 11.0 or above, the Odoo server runs with Python 3.5. Database shell ============== @@ -172,17 +172,71 @@ In the above commands, the argument: * ``--stop-after-init`` will immediately shutdown the server instance after it completed the operations you asked. More options are available and detailed in the -`CLI documentation `_. +`CLI documentation `_. You can find in the logs (*~/logs/odoo.log*) the addons path used by Odoo.sh to run your server. Look for "*odoo: addons paths*": :: - 2018-02-19 10:51:39,267 4 INFO ? odoo: Odoo version 11.0 + 2018-02-19 10:51:39,267 4 INFO ? odoo: Odoo version 13.0 2018-02-19 10:51:39,268 4 INFO ? odoo: Using configuration file at /home/odoo/.config/odoo/odoo.conf - 2018-02-19 10:51:39,268 4 INFO ? odoo: addons paths: ['/home/odoo/data/addons/11.0', '/home/odoo/src/user', '/home/odoo/src/enterprise', '/home/odoo/src/themes', '/home/odoo/src/odoo/addons', '/home/odoo/src/odoo/odoo/addons'] + 2018-02-19 10:51:39,268 4 INFO ? odoo: addons paths: ['/home/odoo/data/addons/13.0', '/home/odoo/src/user', '/home/odoo/src/enterprise', '/home/odoo/src/themes', '/home/odoo/src/odoo/addons', '/home/odoo/src/odoo/odoo/addons'] **Be careful**, especially with your production database. Operations that you perform running this Odoo server instance are not isolated: Changes will be effective in the database. Always, make your tests in your staging databases. + +Debugging in Odoo.sh +==================== + +Debugging an Odoo.sh build is not really different than another Python app. This article only explains the specificities and limitations of the Odoo.sh platform, and assumes that you already know how to use a debugger. + +.. note:: If you don't know how to debug a Python application yet, there are multiple introductory courses that can be easily found on the Internet. + +You can use ``pdb``, ``pudb`` or ``ipdb`` to debug your code on Odoo.sh. +As the server is run outside a shell, you cannot launch the debugger directly from your Odoo instance backend as the debugger needs a shell to operate. + +- `pdb `_ is installed by default in every container. + +- If you want to use `pudb `_ or `ipdb `_ you have to install it before. + + To do so, you have two options: + + - temporary (only in the current build): + + .. code-block:: bash + + $ pip install pudb --user + + or + + .. code-block:: bash + + $ pip install ipdb --user + + - permanent: add ``pudb`` or ``ipdb`` to your project ``requirements.txt`` file. + + +Then edit the code where you want to trigger the debugger and add this: + +.. code-block:: python + + import sys + if sys.__stdin__.isatty(): + import pdb; pdb.set_trace() + +The condition :code:`sys.__stdin__.isatty()` is a hack that detects if you run Odoo from a shell. + +Save the file and then run the Odoo Shell: + +.. code-block:: bash + + $ odoo-bin shell + +Finally, *via* the Odoo Shell, you can trigger the piece of code/function/method +you want to debug. + +.. image:: ./media/pdb_sh.png + :align: center + :alt: Console screenshot showing ``pdb`` running in an Odoo.sh shell. diff --git a/odoo_sh/advanced/frequent_technical_questions.rst b/odoo_sh/advanced/frequent_technical_questions.rst new file mode 100644 index 000000000..2436f225e --- /dev/null +++ b/odoo_sh/advanced/frequent_technical_questions.rst @@ -0,0 +1,45 @@ +:banner: banners/odoo-sh.jpg + +.. _odoosh-advanced-frequent_technical_questions: + +================================== +Frequent Technical Questions +================================== + +"Scheduled actions do not run at the exact time they were expected" +------------------------------------------------------------------- + +On the Odoo.sh platform, we cannot guarantee an exact running time for scheduled actions. + +This is due to the fact that there might be multiple customers on the same server, and we must guarantee a fair share of the server for every customer. Scheduled actions are therefore implemented slightly differently than on a regular Odoo server, and are run on a *best effort* policy. + +.. warning:: + Do not expect any scheduled action to be run more often than every 5 min. + +Are there "best practices" regarding scheduled actions? +------------------------------------------------------- + +**Odoo.sh always limits the execution time of scheduled actions (*aka* crons).** +Therefore, you must keep this fact in mind when developing your own crons. + +We advise that: + +- Your scheduled actions should work on small batches of records. +- Your scheduled actions should commit their work after processing each batch; + this way, if they get interrupted by the time-limit, there is no need to start over. +- Your scheduled actions should be + `idempotent `_: they must not + cause side-effects if they are started more often than expected. + + +Can you install `pycups `_ or some similar library linked to `CUPS `_ ? +-------------------------------------------------------------------------------------------------------------------------------- + +Several community apps for Odoo list ``pycups`` as required dependency. + +- ``pycups`` is a set of Python bindings for the libcups library. They are meant to integrate your computer with a local printing server. +- CUPS is a printing server meant to be used for printers on the same local network as the Odoo server. + +We consider adding new system packages as long as they are indeed used. +Regarding ``pycups``, you won't be able to configure a printer in the local network of your Odoo.sh server. + diff --git a/odoo_sh/advanced/media/pdb_sh.png b/odoo_sh/advanced/media/pdb_sh.png new file mode 100644 index 000000000..aecb6c4af Binary files /dev/null and b/odoo_sh/advanced/media/pdb_sh.png differ diff --git a/odoo_sh/advanced/upgrade_your_database.rst b/odoo_sh/advanced/upgrade_your_database.rst index 1c130e48a..cfdb4e6fe 100644 --- a/odoo_sh/advanced/upgrade_your_database.rst +++ b/odoo_sh/advanced/upgrade_your_database.rst @@ -15,7 +15,8 @@ select the Testing Purpose. If you have custom code, you can choose to have it u it's processed, you'll get a dump of the database in return. .. Warning:: -Do *not* upload *backups* of your production database (found in the Backups tab of the production branch) as these are incompatible with the Upgrade platform - they contain your complete sources, etc. that are not needed for the upgrade. Make sure to download a **Dump** instead - either through the Backups tab using the *Download Dump* button or through the Builds page by using the *Download Dump* entry of the contextual menu of your latest production build. + + Do *not* upload *backups* of your production database (found in the Backups tab of the production branch) as these are incompatible with the Upgrade platform - they contain your complete sources, etc. that are not needed for the upgrade. Make sure to download a **Dump** instead - either through the Backups tab using the *Download Dump* button or through the Builds page by using the *Download Dump* entry of the contextual menu of your latest production build. 2. Test your upgraded database ------------------------------ diff --git a/odoo_sh/getting_started/branches.rst b/odoo_sh/getting_started/branches.rst index 40195f030..0b7e0e9fd 100644 --- a/odoo_sh/getting_started/branches.rst +++ b/odoo_sh/getting_started/branches.rst @@ -43,7 +43,7 @@ instance will be held temporarily unavailable for maintenance reason. This method is equivalent to perform an upgrade of the module through the Apps menu, or through the :code:`-u` switch of -`the command line `_. +`the command line `_. In the case the changes in the commit prevent the server to restart, or if the modules update fails, @@ -55,7 +55,7 @@ The demo data is not loaded, as it is not meant to be used in a production datab The unit tests are not performed, as it would increase the unavailabity time of the production database during the updates. Partners using trial projects should be aware their production branch, along with all the staging branches, -will automatically be set back to the development stage after 15 days. +will automatically be set back to the development stage after 30 days. Staging ------- @@ -175,7 +175,7 @@ staging branches as the emails of your production database are really sent inste Shell ----- -A shell access to your container. You can perform basic linux command (:code:`ls`, :code:`top`) +A shell access to your container. You can perform basic linux commands (:code:`ls`, :code:`top`) and open a shell on your database by typing :code:`psql`. .. image:: ./media/interface-branches-shell.png diff --git a/odoo_sh/getting_started/create.rst b/odoo_sh/getting_started/create.rst index b7ad04a83..a8c6ceaae 100644 --- a/odoo_sh/getting_started/create.rst +++ b/odoo_sh/getting_started/create.rst @@ -108,7 +108,7 @@ Access the URL :file:`/web/database/manager` of your on-premise database and dow If you cannot access the database manager, it may have been disabled by your system administrator. See the `database manager security documentation - `_. + `_. You will need the master password of your database server. If you do not have it, contact your system administrator. diff --git a/odoo_sh/getting_started/first_module.rst b/odoo_sh/getting_started/first_module.rst index 4b0f0648c..4f4b651e8 100644 --- a/odoo_sh/getting_started/first_module.rst +++ b/odoo_sh/getting_started/first_module.rst @@ -150,7 +150,7 @@ Manually -------- If you want to create your module structure manually, -you can follow `Build an Odoo module `_ to understand +you can follow `Build an Odoo module `_ to understand the structure of a module and the content of each file. Push the development branch diff --git a/odoo_sh/getting_started/online-editor.rst b/odoo_sh/getting_started/online-editor.rst index 6442952ed..e36ed1a64 100644 --- a/odoo_sh/getting_started/online-editor.rst +++ b/odoo_sh/getting_started/online-editor.rst @@ -49,6 +49,12 @@ The working directory is composed of the following folders: │ └── pip.log Python packages installation logs You can edit the source code (files under */src*) in development and staging builds. + +.. note:: + Your changes won't be propagated to a new build, you must commit them in your + source code if you want to make them persist. + + For production builds, the source code is read-only, because applying local changes on a production server is not a good practice. diff --git a/odoo_sh/getting_started/settings.rst b/odoo_sh/getting_started/settings.rst index 12f17c24f..cf231824a 100644 --- a/odoo_sh/getting_started/settings.rst +++ b/odoo_sh/getting_started/settings.rst @@ -155,12 +155,9 @@ Most domain managers have the feature to configure this redirection. This is com HTTPS/SSL --------- -You can use a third-party CDN such as *Cloudflare.com* to enable the *HTTPS* support for your custom domain: +If the redirection is correctly set up, the platform will automatically generate an SSL certificate with `Let's Encrypt `_ within the hour and your domain will be accessible through HTTPS. -* `Create a Cloudflare account `_ -* `Change your domain name servers to Cloudflare `_ -* `Choose an SSL mode `_ -* `Redirect your visitors to HTTPS `_ +While it is currently not possible to configure your own SSL certificates on the Odoo.sh platform we are considering the feature. SPF and DKIM compliance ----------------------- diff --git a/point_of_sale/advanced.rst b/point_of_sale/advanced.rst index d823c656e..dfbe5bacd 100644 --- a/point_of_sale/advanced.rst +++ b/point_of_sale/advanced.rst @@ -6,6 +6,6 @@ Advanced topics :titlesonly: advanced/barcode - advanced/multi_cashiers + advanced/multicashiers advanced/reprint advanced/mercury \ No newline at end of file diff --git a/point_of_sale/advanced/reprint.rst b/point_of_sale/advanced/reprint.rst index 19b2175e5..a16785ac9 100644 --- a/point_of_sale/advanced/reprint.rst +++ b/point_of_sale/advanced/reprint.rst @@ -14,7 +14,7 @@ Under the Bills & Receipts category, you will find *Reprint Receipt* option. .. note:: - In order to allow the option reprint receipt, you need to activate the receipt printer. + In order to allow the option reprint receipt, you need to activate the receipt printer. .. image:: media/reprint01.png :align: center diff --git a/portal/my_odoo_portal.rst b/portal/my_odoo_portal.rst index b20177c83..9fb5414d3 100644 --- a/portal/my_odoo_portal.rst +++ b/portal/my_odoo_portal.rst @@ -5,11 +5,11 @@ My Odoo Portal ============== -In this section of the portal you will find all the communications between you -and Odoo, documents such Quotations, Sales Orders, Invoices and your Subscriptions. +In this section of the portal, you will find all the communications between you +and Odoo: documents such as quotations, sales orders, invoices and subscriptions. -.. note :: To access this section you have to log with your username and password - to `Odoo `__ . If you are already logged-in just +.. note :: To access this section, you have to log with your username and password + to `Odoo `__ . If you are already logged in, just click on your name on the top-right corner and select "My Account". @@ -20,55 +20,54 @@ Quotations ========== Here you will find all the quotations sent to you by Odoo. For example, a -quotation can be generated for you after adding an Application or a User to your +quotation can be generated for you after adding an application or a user to your database or if your contract has to be renewed. .. image:: media/quotations.png :align: center -The *Valid Until* column shows until when the quotation is valid; after that date -the quotation will be "Expired". By clicking on the quotation you will see all -the details of the offer, the pricing and other useful information. +The *Valid Until* column shows the date through which the quotation is valid; after that date, +the quotation will be "Expired". By clicking on the quotation, you will see all +the details of the offer, such as the pricing and other useful information. .. image:: media/quotation_accept.png :align: center -If you want to accept the quotation just click "Accept & Pay" and the quote +If you want to accept the quotation, just click "Accept & Pay," and the quote will get confirmed. If you don't want to accept it, or you need to ask for some -modifications, click on "Ask Changes Reject". +modifications, click on "Ask Changes Reject." Sales Orders ============ -All your purchases within Odoo such as Upsells, Themes, Applications, etc. +All your purchases within Odoo (Upsells, Themes, Applications, etc.) will be registered under this section. .. image:: media/sales.png :align: center -By clicking on the sale order you can review the details of the products purchased +By clicking on the sale order, you can review the details of the products purchased and process the payment. Invoices ======== -All the invoices of your subscription(s), or generated by a sales order, will be -shown in this section. The tag before the Amount Due will indicate you if the +All the invoices of your subscriptions and/or sales orders will be +shown in this section. The tag before the Amount Due will indicate if the invoice has been paid. .. image:: media/invoices.png :align: center -Just click on the Invoice if you wish to see more information, pay the invoice +Just click on the invoice if you wish to see more information, pay the invoice, or download a PDF version of the document. Tickets ======= -When you submit a ticket through `Odoo Support `__ +When you submit a ticket through `Odoo Support `, a ticket will be created. Here you can find all the tickets that you have opened, -the conversation between you and our Agents, the Status of the ticket and the ID -(# Ref). +the conversations between you and our Agents, and the statuses and IDs (# Ref) of the tickets. .. image:: media/tickets.png :align: center @@ -76,24 +75,24 @@ the conversation between you and our Agents, the Status of the ticket and the ID Subscriptions ============= -You can access to your Subscription with Odoo from this section. The first page +You can access your subscriptions with Odoo from this section. The first page shows you the subscriptions that you have and their status. .. image:: media/subscriptionstatus.png :align: center -By clicking on the Subscription you will access to all the details regarding your -plan: this includes the number of applications purchased, the billing information +By clicking on the subscription you will access all the details regarding your +plan: the number of applications purchased, the billing information, and the payment method. -To change the payment method click on "Change Payment Method" and enter the new +To change the payment method, click on "Change Payment Method" and enter the new credit card details. .. image:: media/changemethod.png :align: center -If you want to remove the credit cards saved, you can do it by clicking on -"Manage you payment methods" at the bottom of the page. Click then on "Delete" to +If you want to remove the credit cards that are saved, you can do so by clicking on +"Manage your payment methods" at the bottom of the page. Click "Delete" to delete the payment method. .. image:: media/managepayment.png @@ -103,13 +102,13 @@ delete the payment method. information provided or if your credit card has expired, the status of your subscription will change to "To Renew". You will then have 7 days to provide a valid method of payment. After this delay, the subscription will - be closed and you will no longer be able to access the database. + be closed, and you will no longer be able to access the database. Success Packs ============= With a Success Pack/Partner Success Pack, you are assigned an expert to provide unique personalized assistance to help you customize your solution and optimize -your workflows as part of your initial implementation. These hours never expire +your workflows as part of your initial implementation. These hours never expire, allowing you to utilize them whenever you need support. .. seealso :: diff --git a/practical.rst b/practical.rst index 2ceb82b86..83efa5e11 100644 --- a/practical.rst +++ b/practical.rst @@ -11,4 +11,5 @@ Practical Information db_management/db_online db_management/db_premise portal/my_odoo_portal + support legal diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 000000000..71121d994 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +Sphinx<2 \ No newline at end of file diff --git a/sales/products_prices/prices/pricing.rst b/sales/products_prices/prices/pricing.rst index d09c75f88..aa3853be1 100644 --- a/sales/products_prices/prices/pricing.rst +++ b/sales/products_prices/prices/pricing.rst @@ -5,13 +5,20 @@ How to adapt your prices to your customers and apply discounts Odoo has a powerful pricelist feature to support a pricing strategy tailored to your business. A pricelist is a list of prices or price rules that Odoo searches to determine the suggested price. You can set several critarias to use a specific price: periods, min. sold quantity (meet a minimum order quantity and get a price break), etc. -As pricelists only suggest prices, they can be overridden by users completing sales orders. + +As pricelists only suggest prices, they can be overridden by vendors completing sales orders. Choose your pricing strategy from :menuselection:`Sales --> Settings`. .. image:: ./media/pricing_options.png :align: center +.. note:: + + * *A single sale price per product :* doesn't let you adapt prices, it use default product price ; + * *Different prices per customer segment :* you will set several prices per products ; + * *Advanced pricing based on formula :* will let you apply discounts, margins and roundings. + Several prices per product ========================== @@ -59,7 +66,7 @@ Prices per minimum quantity Discounts, margins, roundings ============================= -The third option allows to set price change rules. +*Advanced pricing based on formula* allows to set price change rules. Changes can be relative to the product list/catalog price, the product cost price, or to another pricelist. Changes are calculated via discounts or surcharges and can be forced to fit within floor (minumum margin) and ceilings (maximum margins). diff --git a/sales/send_quotations/deadline.rst b/sales/send_quotations/deadline.rst index 3e714f405..8e09f7403 100644 --- a/sales/send_quotations/deadline.rst +++ b/sales/send_quotations/deadline.rst @@ -2,8 +2,8 @@ Stimulate customers with quotations deadline ============================================ -As you send quotations, it is important to set a quotation deadline; -Both to entice your customer into action with the fear of missing out on +As you send quotations, it is important to set a quotation deadline, +both to entice your customer into action with the fear of missing out on an offer and to protect yourself. You don't want to have to fulfill an order at a price that is no longer cost effective for you. @@ -26,7 +26,7 @@ can find more info about quotation templates `here .. image:: media/quotationsdeadline02.png :align: center -On your customer side, they will see this. +On your customer side, they will see this: .. image:: media/quotationsdeadline03.png :align: center diff --git a/sales/send_quotations/quote_template.rst b/sales/send_quotations/quote_template.rst index f043808ff..87ddf7ff6 100644 --- a/sales/send_quotations/quote_template.rst +++ b/sales/send_quotations/quote_template.rst @@ -32,7 +32,7 @@ On each template, you can also specify discounts if the option is activated in the *Sales* settings. The base price is set in the product configuration and can be alterated by customer pricelists. -.. TODO (TO LINK DOC LATER WHEN DONE based on this https://www.odoo.com/documentation/user/11.0/sales/products_prices/prices/pricing.html +.. TODO (TO LINK DOC LATER WHEN DONE based on this https://www.odoo.com/documentation/user/13.0/sales/products_prices/prices/pricing.html Edit your template ================== diff --git a/support.rst b/support.rst new file mode 100644 index 000000000..6be371b64 --- /dev/null +++ b/support.rst @@ -0,0 +1,13 @@ +:banner: banners/support.jpg + +======= +Support +======= + +.. toctree:: + :titlesonly: + + support/where_can_i_get_support + support/what_can_i_expect + support/supported_versions + support/user_doc diff --git a/support/media/add_text.png b/support/media/add_text.png new file mode 100644 index 000000000..8a2d6a674 Binary files /dev/null and b/support/media/add_text.png differ diff --git a/support/media/edit_on_github.png b/support/media/edit_on_github.png new file mode 100644 index 000000000..af4c901ad Binary files /dev/null and b/support/media/edit_on_github.png differ diff --git a/support/media/preview_changes.png b/support/media/preview_changes.png new file mode 100644 index 000000000..ce271601e Binary files /dev/null and b/support/media/preview_changes.png differ diff --git a/support/media/propose_changes.png b/support/media/propose_changes.png new file mode 100644 index 000000000..ad0a20825 Binary files /dev/null and b/support/media/propose_changes.png differ diff --git a/support/supported_versions.rst b/support/supported_versions.rst new file mode 100644 index 000000000..f51c6c7ff --- /dev/null +++ b/support/supported_versions.rst @@ -0,0 +1,72 @@ +.. :banner: banners/support.jpg + + +================== +Supported versions +================== + + +Odoo provides support and bug fixing **for the 3 last major versions** of Odoo. + +Users hosted on **Odoo Online** may use intermediary versions (sometimes called *SaaS versions*) that are +supported as well. These versions are not published for Odoo.sh or On-Premise +installations. + + +What's the support status of my Odoo? +===================================== + +This matrix shows the support status of every version. + +**Major releases are in bold type.** + ++--------------------+-------------+---------+--------------+----------------+----------------------------------------------+ +| | Odoo Online | Odoo.sh | On-Premise | Release date | | ++====================+=============+=========+==============+================+==============================================+ +| **Odoo 13.0** | 🏁 | 🏁 | 🏁 | October 2019 | | ++--------------------+-------------+---------+--------------+----------------+----------------------------------------------+ +| Odoo 12.saas~3 | 🟢 | N/A | N/A | August 2019 | | ++--------------------+-------------+---------+--------------+----------------+----------------------------------------------+ +| **Odoo 12.0** | 🟢 | 🟢 | 🟢 | October 2018 | | ++--------------------+-------------+---------+--------------+----------------+----------------------------------------------+ +| Odoo 11.saas~3 | 🟢 | N/A | N/A | April 2018 | | ++--------------------+-------------+---------+--------------+----------------+----------------------------------------------+ +| **Odoo 11.0** | 🟢 | 🟢 | 🟢 | October 2017 | | ++--------------------+-------------+---------+--------------+----------------+----------------------------------------------+ +| Odoo 10.saas~15 | 🟢 | N/A | N/A | March 2017 | | ++--------------------+-------------+---------+--------------+----------------+----------------------------------------------+ +| Odoo 10.saas~14 | 🟢 | N/A | N/A | January 2017 | | ++--------------------+-------------+---------+--------------+----------------+----------------------------------------------+ +| **Odoo 10.0** | 🟢 | 🟢 | 🟢 | October 2016 | *End-of-support is planned for October 2019* | ++--------------------+-------------+---------+--------------+----------------+----------------------------------------------+ +| Odoo 9.saas~11 | 🟠 | N/A | N/A | May 2016 | | ++--------------------+-------------+---------+--------------+----------------+----------------------------------------------+ +| **Odoo 9.0** | 🟠 | N/A | 🔴 | October 2015 | | ++--------------------+-------------+---------+--------------+----------------+----------------------------------------------+ +| Odoo 8.saas~6 | 🟠 | N/A | N/A | February 2015 | | ++--------------------+-------------+---------+--------------+----------------+----------------------------------------------+ +| **Odoo 8.0** | 🟠 | N/A | 🔴 | September 2014 | | ++--------------------+-------------+---------+--------------+----------------+----------------------------------------------+ + + +.. note:: + + 🟢 Supported version + + 🔴 End-of-support + + N/A Never released for this platform + + 🟠 Some of our older customers may still run this version on our Odoo Online servers, we provide help only on blocking issues and advise you to upgrade. + + 🏁 Future version, not released yet + + +I run an older version of Odoo/OpenERP/TinyERP +============================================== + +OpenERP 7.0, 6.1, 6.0 and 5.0 is not supported anymore, on any platform. + +TinyERP 4.0, 3.0, 2.0 and 1.0 is not supported anymore, on any platform. + +You should consider `upgrading `_ your database. diff --git a/support/user_doc.rst b/support/user_doc.rst new file mode 100644 index 000000000..d306765ed --- /dev/null +++ b/support/user_doc.rst @@ -0,0 +1,149 @@ +.. :banner: banners/support.jpg + + +=============================== +Contribute to the documentation +=============================== + +First of all... +=============== + +**... Thank you for landing here and helping us to improve the user documentation of Odoo.** + + +Edit an existing page +===================== + +0. As our documentation is maintained on GitHub, you'll need a free `GitHub account `_. +1. Pick a page in our `user documentation `_. **Please take care of choosing the right version of Odoo.** +2. Click on **Edit on Github** in the left menu. + + .. image:: ./media/edit_on_github.png + :align: center + :alt: Click on "Edit on Github". + +3. If this is the first time you edit our documentation, click on **Fork repository**, else you won't see this step. +4. Use Github's editor to add your text. Text is tagged with a simple syntax called `RST `_. Don't worry, it's not so hard to learn 🤓... See the following section of this document for a quick overview of RST commands. + + .. image:: ./media/add_text.png + :align: center + :alt: Use Github's editor to add your text. + +5. Click on **Preview changes** to review your contribution in a human-readable format. + + .. image:: ./media/preview_changes.png + :align: center + :alt: Click on "Preview changes" to review your contribution. + +6. In the **Propose file change** section, add a short title to your contribution. The title should summarize your changes. You may use the second box to add an extended description if your contribution requires a longer explanation. + + .. image:: ./media/propose_changes.png + :align: center + :alt: Add a title and submit your contribution. + +7. Submit your contribution by clicking on **Propose file change**. +8. Click on **Create pull request**. +9. Wait for an Odoo maintainer to add your contribution. Thank you for your help! + +.. warning:: + There is no automatic port of your edit to another version of the documentation. + + If your change should apply to multiple versions of Odoo, please warn us in your contribution message. + + +RST Cheat Sheet +--------------- + +Here is a summary of the markup elements you may use while editing our documentation. + ++------------------------------+--------------------------+---------------------------------------+ +| Code | Display | Comments | ++==============================+==========================+=======================================+ +| .. code-block:: rst | Text in *italics* | | +| | | | +| Text in *italics* | | | ++------------------------------+--------------------------+---------------------------------------+ +| .. code-block:: rst | Text in **bold** letters | | +| | | | +| Text in **bold** letters | | | ++------------------------------+--------------------------+---------------------------------------+ +| .. code-block:: rst | 1. Numbered | Must be surrounded by white lines. | +| | 2. Bullet | | +| 1. Numbered | 3. List | | +| 2. Bullet | | | +| 3. List | | | ++------------------------------+--------------------------+---------------------------------------+ +| .. code-block:: rst | - Numbered | Must be surrounded by white lines. | +| | - Bullet | | +| - Bullet | - List | | +| - Point | | | +| - List | | | ++------------------------------+--------------------------+---------------------------------------+ +| .. code-block:: rst | This is `a hyper link | - Here is `how to enter backticks | +| | `_.| on your keyboard | +| This is `a hyper link | | `_. | +| `_. | | - Don't forget terminal *underscore*. | ++------------------------------+--------------------------+---------------------------------------+ + + +.. note:: + There are many more commands available, see `comprehensive documentation `_ of RST. + + +Add images to your documents +============================ + + +.. warning:: + This procedure is possible only for users who have **push** access on the documentation repository (eg: mainly, Odoo maintainers). + We are working on improving this. + +1. First of all, prepare your screenshots. + + - They must be good-quality PNG images. + - Crop your screenshots to display only the relevant part of the screen. Large screenshots are hard + to read and don't display well in a documentation. + - Always take your screenshots on a demo instance of Odoo; **never** include any personal data. + +2. Upload them to the ``media/`` directory which is located next to the page you are editing. If the directory does not exist, create it. +3. When editing your page, use this code piece in order to load your image: + + .. code-block:: rst + + .. image:: ./media/your_image_file.png + :align: center + :alt: Text that is displayed when your image is not available (eg: for screen readers and other accessibility tools) + +4. Submit your changes + + +.. Add a page about a new topic +.. ============================ + +.. TODO + + + +Technical Details for Nerds +=========================== + +Advanced users may, of course, fork and clone `the GitHub repository `_. +Then submit a pull request with the canonical Git/GitHub workflow. + +See our `README `_ file about building +the documentation. + + +Developer documentation +======================= + +Documentation that targets developers of Odoo apps is maintained alongside `the source code of Odoo `_. + +.. note:: + User documentation might contain technicalities yet, when they are related to configuration and everyday use of Odoo. + + + +.. |date| date:: + +*Last revision of this page:* |date| diff --git a/support/what_can_i_expect.rst b/support/what_can_i_expect.rst new file mode 100644 index 000000000..101e89e1b --- /dev/null +++ b/support/what_can_i_expect.rst @@ -0,0 +1,57 @@ +.. :banner: banners/support.jpg + + +.. _support-expectations: + +=========================================== +What can I expect from the support service? +=========================================== + + +5 days a week +============= + +Your Odoo Online subscription includes **unlimited 24hr support at no extra +cost, Monday to Friday**. Our teams are located around the world to ensure you +have support, no matter your location. Your support representative could be +communicating to you from San Francisco, Belgium, or India! + +Our support team can be contacted through our `online support form `__. + + +What kind of support is included? +================================= + +- Providing you with relevant material (guidelines, product documentation, + etc...) +- Answers to issues that you may encounter in your standard Odoo database (eg. + “I cannot close my Point of Sale” or “I cannot find my sales KPIs?”) +- Questions related to your account, subscription, or billing +- Bug resolution (blocking issues or unexpected behaviour not due to + misconfiguration or customization) +- Issues that might occur in a test database after upgrading to a newer version + +*Odoo Support does not make changes to your production database, but gives you +the material and knowledge to do it yourself!* + + +What kind of support is not included? +===================================== + +- Questions that require us to understand your business processes in order to + help you implement your database +- Training on how to use our software (we will direct you to our many resources) +- Import of documents into your database +- Guidance on which configurations to apply inside of an application or the database +- How to set up configuration models (Examples include: Inventory Routes, + Payment Terms, Warehouses, etc) +- Any intervention on your own servers/deployments of Odoo +- Questions or issues related to specific developments or customizations done + either by Odoo or a third party (this is specific only to your database or + involving code) + +You can get this type of support with a `Success Pack `__. +With a pack, one of our consultants will analyze the way your business runs and +tell you how you can get the most out of your Odoo Database. We will handle all +configurations and coach you on how to use Odoo. + diff --git a/support/where_can_i_get_support.rst b/support/where_can_i_get_support.rst new file mode 100644 index 000000000..056c26145 --- /dev/null +++ b/support/where_can_i_get_support.rst @@ -0,0 +1,36 @@ +.. :banner: banners/support.jpg + + +=================== +Where to find help? +=================== + + +Odoo Enterprise +=============== + +Users who have a valid Odoo Enterprise subscription may always contact our support teams through our `support form `_, no matter the hosting type you chose (Odoo Online, Odoo.sh or on your own server). + +Please include in your request: + +- your subscription number, +- if your database is hosted by Odoo (Odoo Online or Odoo.sh), please also send the URL of your database. + +Our agents will get back to you as soon as possible. + + +Odoo Community +============== + +*Odoo Community users don't get access to the support service.* + +Here are some resources that might help you: + +- Our `documentation pages `_. +- Ask your question on the `community forum `_. +- `Buy Odoo Enterprise `_ to get the support and bugfix services. + + +.. |date| date:: + +*Last revision of this page:* |date| diff --git a/website/publish/domain_name.rst b/website/publish/domain_name.rst index f622f4a9a..37d18c04e 100644 --- a/website/publish/domain_name.rst +++ b/website/publish/domain_name.rst @@ -84,9 +84,12 @@ We can now apply the redirection from your domain name's manager account: How to enable SSL (HTTPS) for my Odoo instance ============================================== -To enable SSL, please use a third-party CDN service provider -such as CloudFlare.com. +Until recently, Odoo users needed to use a third-party CDN service provider such as CloudFlare to enable SSL. +It is not required anymore: Odoo generates the certificate for you automatically, using integration with `Let's Encrypt Certificate Authority and ACME protocol `__. +In order to get this, simply add your domain name in your customer portal (a separate certificate is generated for each domain name specified). + +If you already use CloudFlare or a similar service, you can keep using it or simply change for Odoo. The choice is yours. My website is indexed twice by Google ===================================== diff --git a/website/publish/media/domain_name01.png b/website/publish/media/domain_name01.png index e5fa65d94..e3671734c 100644 Binary files a/website/publish/media/domain_name01.png and b/website/publish/media/domain_name01.png differ diff --git a/website/publish/media/domain_name02.png b/website/publish/media/domain_name02.png index 98acea816..247004bd4 100644 Binary files a/website/publish/media/domain_name02.png and b/website/publish/media/domain_name02.png differ diff --git a/website/publish/media/domain_name03.png b/website/publish/media/domain_name03.png index c8e4c2f76..7bc3948d5 100644 Binary files a/website/publish/media/domain_name03.png and b/website/publish/media/domain_name03.png differ diff --git a/website/publish/media/domain_name04.png b/website/publish/media/domain_name04.png index 9b9671768..022cfde99 100644 Binary files a/website/publish/media/domain_name04.png and b/website/publish/media/domain_name04.png differ diff --git a/website/publish/multi_website.rst b/website/publish/multi_website.rst index 6ab61d0d9..f0f99d0b0 100644 --- a/website/publish/multi_website.rst +++ b/website/publish/multi_website.rst @@ -116,9 +116,9 @@ be redirected to the right website using Geo IP. .. image:: media/multi_website18.png :align: center -.. note:: -Geo IP is installed by default in Odoo Online. If you run Odoo -on-premise, don’t forget to install *Geoip* library. +.. note:: + Geo IP is installed by default in Odoo Online. If you run Odoo + on-premise, don’t forget to install *Geoip* library. `Read the full documenation about domain names here `__,