NextERP/documentation
5
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[IMP] *: harmonize formatting

Browse Source 
- Removed the numbering from headings because it was either inconsistent, breaking the implicit hyperlink target or useless.
- Fixed incorrect heading formattings.
- Replaced hand-written flows by the :menuselection: directive
This commit is contained in:
Antoine Vandevenne (anv)
2020-01-08 11:05:57 +01:00
committed by Antoine Vandevenne (anv)
parent 73fff57983
commit 4bb2eeda11
78 changed files with 810 additions and 621 deletions
Download Patch File Download Diff File Expand all files Collapse all files
general/base_import/import_faq.rst
+118 -65
View File
@@ -17,7 +17,6 @@ There you are provided with templates you can easily populate
with your own data. Such templates can be imported in one click;
The data mapping is already done.
How to adapt the template
-------------------------
@@ -78,19 +77,28 @@ 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 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'.
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.
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.
.. note::
If you are importing an excel (.xls, .xlsx) file, you can use date cells to store dates as the display of dates in excel is different from the way it is stored. That way you will be sure that the date format is correct in Odoo whatever your locale date format is.
If you are importing an excel (.xls, .xlsx) file, you can use date cells to store dates as the
display of dates in excel is different from the way it is stored. That way you will be sure that
the date format is correct in Odoo whatever your locale date format is.
Can I import numbers with currency sign (e.g.: $32.00)?
-------------------------------------------------------
Yes, we fully support numbers with parenthesis to represent negative sign as well as numbers with currency sign attached to them. Odoo also automatically detect which thousand/decimal separator you use (you can change those under **options**). If you use a currency symbol that is not known to Odoo, it might not be recognized as a number though and it will crash.
Yes, we fully support numbers with parenthesis to represent negative sign as well as numbers with
currency sign attached to them. Odoo also automatically detect which thousand/decimal separator you
use (you can change those under **options**). If you use a currency symbol that is not known to
Odoo, it might not be recognized as a number though and it will crash.
Examples of supported numbers (using thirty-two thousands as an example):
@@ -107,36 +115,42 @@ Example that will not work:
- ABC 32.000,00
- $ (32.000,00)
What can I do when the Import preview table isn't displayed correctly?
----------------------------------------------------------------------
By default the Import preview is set on commas as field separators and quotation marks as text delimiters. If your csv file does not have these settings, you can modify the File Format Options (displayed under the Browse CSV file bar after you select your file).
Note that if your CSV file has a tabulation as separator, Odoo will not detect the separations. You will need to change the file format options in your spreadsheet application. See the following question.
By default the Import preview is set on commas as field separators and quotation marks as text
delimiters. If your csv file does not have these settings, you can modify the File Format Options
(displayed under the Browse CSV file bar after you select your file).
Note that if your CSV file has a tabulation as separator, Odoo will not detect the separations. You
will need to change the file format options in your spreadsheet application. See the following
question.
How can I change the CSV file format options when saving in my spreadsheet application?
---------------------------------------------------------------------------------------
If you edit and save CSV files in speadsheet applications, your computer's regional settings will be applied for the separator and delimiter. We suggest you use OpenOffice or LibreOffice Calc as they will allow you to modify all three options (in 'Save As' dialog box > Check the box 'Edit filter settings' > Save).
Microsoft Excel will allow you to modify only the encoding when saving (in 'Save As' dialog box > click 'Tools' dropdown list > Encoding tab).
If you edit and save CSV files in spreadsheet applications, your computer's regional settings will
be applied for the separator and delimiter. We suggest you use OpenOffice or LibreOffice Calc as
they will allow you to modify all three options (in :menuselection:`'Save As' dialog box --> Check the
box 'Edit filter settings' --> Save`).
Microsoft Excel will allow you to modify only the encoding when saving (in :menuselection:`'Save As'
dialog box --> click 'Tools' dropdown list --> Encoding tab`).
What's the difference between Database ID and External ID?
----------------------------------------------------------
Some fields define a relationship with another object. For example, the country of a contact is a link to a record of the 'Country' object. When you want to import such fields, Odoo will have to recreate links between the different records. To help you import such fields, Odoo provides 3 mechanisms. You must use one and only one mechanism per field you want to import.
Some fields define a relationship with another object. For example, the country of a contact is a
link to a record of the 'Country' object. When you want to import such fields, Odoo will have to
recreate links between the different records. To help you import such fields, Odoo provides three
mechanisms. You must use one and only one mechanism per field you want to import.
For example, to reference the country of a contact, Odoo proposes you 3 different fields to import:
- Country: the name or code of the country
- Country/Database ID: the unique Odoo ID for a record, defined by the ID postgresql column
- Country/External ID: the ID of this record referenced in another application (or the .XML file that imported it)
- Country/External ID: the ID of this record referenced in another application (or the .XML file
that imported it)
For the country Belgium, you can use one of these 3 ways to import:
@@ -144,92 +158,123 @@ For the country Belgium, you can use one of these 3 ways to import:
- Country/Database ID: 21
- Country/External ID: base.be
According to your need, you should use one of these 3 ways to reference records in relations. Here is when you should use one or the other, according to your need:
According to your need, you should use one of these 3 ways to reference records in relations. Here
is when you should use one or the other, according to your need:
- Use Country: This is the easiest way when your data come from CSV files that have been created manually.
- Use Country/Database ID: You should rarely use this notation. It's mostly used by developers as it's main advantage is to never have conflicts (you may have several records with the same name, but they always have a unique Database ID)
- Use Country: This is the easiest way when your data come from CSV files that have been created
manually.
- Use Country/Database ID: You should rarely use this notation. It's mostly used by developers as
it's main advantage is to never have conflicts (you may have several records with the same name,
but they always have a unique Database ID)
- Use Country/External ID: Use External ID when you import data from a third party application.
When you use External IDs, you can import CSV files with the "External ID" column to define the External ID of each record you import. Then, you will be able to make a reference to that record with columns like "Field/External ID". The following two CSV files give you an example for Products and their Categories.
When you use External IDs, you can import CSV files with the "External ID" column to define the
External ID of each record you import. Then, you will be able to make a reference to that record
with columns like "Field/External ID". The following two CSV files give you an example for Products
and their Categories.
`CSV file for categories <../../_static/example_files/External_id_3rd_party_application_product_categories.csv>`_.
`CSV file for Products <../../_static/example_files/External_id_3rd_party_application_products.csv>`_.
:download:`CSV file for categories
<../../_static/example_files/External_id_3rd_party_application_product_categories.csv>`.
:download:`CSV file for Products
<../../_static/example_files/External_id_3rd_party_application_products.csv>`.
What can I do if I have multiple matches for a field?
-----------------------------------------------------
If for example you have two product categories with the child name "Sellable" (ie. "Misc. Products/Sellable" & "Other Products/Sellable"), your validation is halted but you may still import your data. However, we recommend you do not import the data because they will all be linked to the first 'Sellable' category found in the Product Category list ("Misc. Products/Sellable"). We recommend you modify one of the duplicates' values or your product category hierarchy.
However if you do not wish to change your configuration of product categories, we recommend you use make use of the external ID for this field 'Category'.
If for example you have two product categories with the child name "Sellable" (ie. "Misc.
Products/Sellable" & "Other Products/Sellable"), your validation is halted but you may still import
your data. However, we recommend you do not import the data because they will all be linked to the
first 'Sellable' category found in the Product Category list ("Misc. Products/Sellable"). We
recommend you modify one of the duplicates' values or your product category hierarchy.
However if you do not wish to change your configuration of product categories, we recommend you use
make use of the external ID for this field 'Category'.
How can I import a many2many relationship field (e.g. a customer that has multiple tags)?
-----------------------------------------------------------------------------------------
The tags should be separated by a comma without any spacing. For example, if you want your customer to be linked to both tags 'Manufacturer' and 'Retailer' then you will encode "Manufacturer,Retailer" in the same column of your CSV file.
`CSV file for Manufacturer, Retailer <../../_static/example_files/m2m_customers_tags.csv>`_.
The tags should be separated by a comma without any spacing. For example, if you want your customer
to be linked to both tags 'Manufacturer' and 'Retailer' then you will encode "Manufacturer,Retailer"
in the same column of your CSV file.
:download:`CSV file for Manufacturer, Retailer <../../_static/example_files/m2m_customers_tags.csv>`
How can I import a one2many relationship (e.g. several Order Lines of a Sales Order)?
-------------------------------------------------------------------------------------
If you want to import sales order having several order lines; for each order line, you need to reserve a specific row in the CSV file. The first order line will be imported on the same row as the information relative to order. Any additional lines will need an addtional row that does not have any information in the fields relative to the order.
As an example, here is purchase.order_functional_error_line_cant_adpat.CSV file of some quotations you can import, based on demo data.
If you want to import sales order having several order lines; for each order line, you need to
reserve a specific row in the CSV file. The first order line will be imported on the same row as the
information relative to order. Any additional lines will need an additional row that does not have
any information in the fields relative to the order. As an example, here is
``purchase.order_functional_error_line_cant_adpat.CSV`` file of some quotations you can import,
based on demo data.
`File for some Quotations <../../_static/example_files/purchase.order_functional_error_line_cant_adpat.csv>`_.
:download:`File for some Quotations
<../../_static/example_files/purchase.order_functional_error_line_cant_adpat.csv>`.
The following CSV file shows how to import purchase orders with their respective purchase order lines:
The following CSV file shows how to import purchase orders with their respective purchase order
lines:
`Purchase orders with their respective purchase order lines <../../_static/example_files/o2m_purchase_order_lines.csv>`_.
:download:`Purchase orders with their respective purchase order lines
<../../_static/example_files/o2m_purchase_order_lines.csv>`.
The following CSV file shows how to import customers and their respective contacts:
`Customers and their respective contacts <../../_static/example_files/o2m_customers_contacts.csv>`_.
:download:`Customers and their respective contacts
<../../_static/example_files/o2m_customers_contacts.csv>`.
Can I import several times the same record?
-------------------------------------------
If you import a file that contains one of the column "External ID" or "Database ID", records that have already been imported will be modified instead of being created. This is very usefull as it allows you to import several times the same CSV file while having made some changes in between two imports. Odoo will take care of creating or modifying each record depending if it's new or not.
This feature allows you to use the Import/Export tool of Odoo to modify a batch of records in your favorite spreadsheet application.
If you import a file that contains one of the column "External ID" or "Database ID", records that
have already been imported will be modified instead of being created. This is very usefull as it
allows you to import several times the same CSV file while having made some changes in between two
imports. Odoo will take care of creating or modifying each record depending if it's new or not.
This feature allows you to use the Import/Export tool of Odoo to modify a batch of records in your
favorite spreadsheet application.
What happens if I do not provide a value for a specific field?
--------------------------------------------------------------
If you do not set all fields in your CSV file, Odoo will assign the default value for every non defined fields. But if you set fields with empty values in your CSV file, Odoo will set the EMPTY value in the field, instead of assigning the default value.
If you do not set all fields in your CSV file, Odoo will assign the default value for every non
defined fields. But if you set fields with empty values in your CSV file, Odoo will set the EMPTY
value in the field, instead of assigning the default value.
How to export/import different tables from an SQL application to Odoo?
----------------------------------------------------------------------
If you need to import data from different tables, you will have to recreate relations between records belonging to different tables. (e.g. if you import companies and persons, you will have to recreate the link between each person and the company they work for).
If you need to import data from different tables, you will have to recreate relations between
records belonging to different tables. (e.g. if you import companies and persons, you will have to
recreate the link between each person and the company they work for).
To manage relations between tables, you can use the "External ID" facilities of Odoo. The "External ID" of a record is the unique identifier of this record in another application. This "External ID" must be unique accoss all the records of all objects, so it's a good practice to prefix this "External ID" with the name of the application or table. (like 'company_1', 'person_1' instead of '1')
To manage relations between tables, you can use the "External ID" facilities of Odoo. The "External
ID" of a record is the unique identifier of this record in another application. This "External ID"
must be unique across all the records of all objects, so it's a good practice to prefix this
"External ID" with the name of the application or table. (like 'company_1', 'person_1' instead of
'1')
As an example, suppose you have a SQL database with two tables you want to import: companies and persons. Each person belong to one company, so you will have to recreate the link between a person and the company he work for. (If you want to test this example, here is a <a href="/base_import/static/csv/database_import_test.sql">dump of such a PostgreSQL database</a>)
As an example, suppose you have a SQL database with two tables you want to import: companies and
persons. Each person belong to one company, so you will have to recreate the link between a person
and the company he work for. (If you want to test this example, here is a :download:`dump of such a
PostgreSQL database <../../_static/example_files/database_import_test.sql>`)
We will first export all companies and their "External ID". In PSQL, write the following command:
.. code-block:: sh
> copy (select 'company_'||id as "External ID",company_name as "Name",'True' as "Is a Company" from companies) TO '/tmp/company.csv' with CSV HEADER;
> copy (select 'company_'||id as "External ID",company_name as "Name",'True' as "Is a Company" from companies) TO '/tmp/company.csv' with CSV HEADER;
This SQL command will create the following CSV file::
This SQL command will create the following CSV file:
External ID,Name,Is a Company
company_1,Bigees,True
company_2,Organi,True
company_3,Boum,True
.. code-block:: text
External ID,Name,Is a Company
company_1,Bigees,True
company_2,Organi,True
company_3,Boum,True
To create the CSV file for persons, linked to companies, we will use the following SQL command in PSQL:
@@ -237,14 +282,22 @@ To create the CSV file for persons, linked to companies, we will use the followi
> copy (select 'person_'||id as "External ID",person_name as "Name",'False' as "Is a Company",'company_'||company_id as "Related Company/External ID" from persons) TO '/tmp/person.csv' with CSV
It will produce the following CSV file::
It will produce the following CSV file:
External ID,Name,Is a Company,Related Company/External ID
person_1,Fabien,False,company_1
person_2,Laurence,False,company_1
person_3,Eric,False,company_2
person_4,Ramsy,False,company_3
.. code-block:: text
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).
External ID,Name,Is a Company,Related Company/External ID
person_1,Fabien,False,company_1
person_2,Laurence,False,company_1
person_3,Eric,False,company_2
person_4,Ramsy,False,company_3
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.
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
original database).
The two files produced are ready to be imported in Odoo without any modifications. After having
imported these two CSV files, you will have 4 contacts and 3 companies. (the firsts two contacts are
linked to the first company). You must first import the companies and then the persons.
general/in_app_purchase/in_app_purchase.rst
+35 -11
View File
@@ -1,47 +1,71 @@
==================================================
General guide about In-App Purchase (IAP) Services
==================================================
In-App Purchases (IAP) gives access to additional services through Odoo. For instance, it allows me to send SMS Text Messages or to send Invoices by post directly from my database.
In-App Purchases (IAP) gives access to additional services through Odoo. For instance, it allows me
to send SMS Text Messages or to send Invoices by post directly from my database.
Buying Credits
==============
Each IAP Service relies on prepaid credits to work and has its own pricing. To consult my current balance or to recharge my account, go to *Settings> Odoo IAP > View my Services*.
Each IAP Service relies on prepaid credits to work and has its own pricing. To consult my current
balance or to recharge my account, go to :menuselection:`Settings --> Odoo IAP -->
View my Services`.
.. image:: media/image1.png
:align: center
.. tip:: If I am on Odoo Online (SAAS) and have the Enterprise version, I benefit from free credits to test our IAP features.
.. tip::
If I am on Odoo Online (SAAS) and have the Enterprise version, I benefit from free credits to
test our IAP features.
IAP accounts
============
Credits to use IAP services are stored on IAP accounts, which are specific to each service and database. By default, IAP accounts are common to all companies, but can be restricted to specific ones by going to *Settings app > Activate the Developer Mode > Technical Settings > IAP Accoun*.
Credits to use IAP services are stored on IAP accounts, which are specific to each service and
database. By default, IAP accounts are common to all companies, but can be restricted to specific
ones by going to :menuselection:`Settings app --> Activate the Developer Mode --> Technical Settings
--> IAP Account`.
.. image:: media/image2.png
:align: center
IAP Portal
==========
The IAP Portal is a platform regrouping my IAP Services. It is accessible from *Settings app > Odoo IAP > View my Services*. From there, I can view my current balance, recharge my credits, review my consumption and set a reminder to when credits are low.
The IAP Portal is a platform regrouping my IAP Services. It is accessible from
:menuselection:`Settings app --> Odoo IAP --> View my Services`. From there, I can view my current
balance, recharge my credits, review my consumption and set a reminder to when credits are low.
.. image:: media/image3.png
:align: center
Get notified when credits are low
=================================
To be notified when it’s time to recharge my credits, I’ll go to my IAP Portal through *Settings app> Odoo IAP > View my Services*, unfold a service and mark the Receive threshold warning option.
Then, I’ll provide a minimum amount of credits and email addresses. Now, every time that the limit is reached, an automatic reminder will be sent to by email!
To be notified when it’s time to recharge my credits, I’ll go to my IAP Portal through
:menuselection:`Settings app --> Odoo IAP --> View my Services`, unfold a service and mark the
Receive threshold warning option. Then, I’ll provide a minimum amount of credits and email
addresses. Now, every time that the limit is reached, an automatic reminder will be sent to by
email!
.. image:: media/image4.png
:align: center
IAP services available
======================
Different services are available depending on the hosting type of your Database:
- *Odoo Online (SAAS)*: only the IAP services provided by Odoo can be used (i.e. the SMS, Snailmail, Reveal and Partner Autocomplete features);
- *Odoo.sh and Odoo Enterprise (on-premise)*: both the services provided by Odoo and by third-party apps can be used.
- *Odoo Online (SAAS)*: only the IAP services provided by Odoo can be used (i.e. the SMS, Snailmail,
Reveal and Partner Autocomplete features);
- *Odoo.sh and Odoo Enterprise (on-premise)*: both the services provided by Odoo and by third-party
apps can be used.
Offering my own services
========================
I am more than welcome to offer my own IAP services through Odoo Apps! It is the perfect opportunity to get recurring revenue for an ongoing service use rather than — and possibly instead of — a sole initial purchase. Please, find more information at: `In-App Purchase <https://www.odoo.com/documentation/master/webservices/iap.html>`_
I am more than welcome to offer my own IAP services through Odoo Apps! It is the perfect opportunity
to get recurring revenue for an ongoing service use rather than — and possibly instead of — a sole
initial purchase. Please, find more information at: `In-App Purchase
<https://www.odoo.com/documentation/master/webservices/iap.html>`_
general/odoo_basics/add_user.rst
+2 -1
View File
@@ -39,7 +39,8 @@ log-in.
You can also add a new user on the fly from your dashboard. From the above screenshot,
enter the email address of the user you would like to add and click on **INVITE**.
The user will receive an email invite containing a link to set his password. You
will then be able to define his accesses rights under the :menuselection:`Settings --> Users menu`.
will then be able to define his accesses rights under the :menuselection:`Settings -->
Users menu`.
.. seealso::
* `Deactivating Users <../../db_management/documentation.html#deactivating-users>`_