Compare commits

...

151 Commits

Author SHA1 Message Date
Ray Carnes
817e0a2202
Update ocr.rst
Add link to try the OCR service, cleanup copy.
2022-03-04 11:49:39 -08:00
Jonathan Castillo (jcs)
01c4b71845 [IMP] install/maintain: new improved doc about domain names
task-id 2680490

closes odoo/documentation#1648

X-original-commit: d22f95362a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-03 19:00:39 +00:00
Odoo Translation Bot
dbac6d8fe1 [I18N] Update translation terms from Transifex 2022-02-27 00:30:36 +01:00
Jonathan Castillo (jcs)
2fb106bace [IMP] accounting: fix a typo in eu_distance_selling.rst
closes odoo/documentation#1635

X-original-commit: 3c0b7783b8
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-02-24 16:46:02 +00:00
Thibault Libioulle
ff55b18aa2 [IMP] general/payment_acquirers: add Stripe Connect documentation
This commit adds the user documentation about the modification done in
the payment onboarding and the new Stripe Connect capabilities.

task-2685160

closes odoo/documentation#1447

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-23 16:19:47 +00:00
Antoine Vandevenne (anv)
69ff7243bf [IMP] extensions: add content tabs (backport of cf6ca0fb)
closes odoo/documentation#1626

X-original-commit: 286b01a241
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-23 13:55:08 +00:00
Stanislas Sobieski
3209a45f7c [FW][REV] odoo_sh: revert commit 6c48f90
closes odoo/documentation#1620

Forward-port-of: odoo/documentation#1618
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-22 17:05:58 +00:00
Obay Abdelgadir
1c6cbd2bd6 [IMP] install: remove deprecated ssl instruction in deploy.rst
Backport of commit d227ab66b0 on #1448

closes odoo/documentation#1614

X-original-commit: a80f3c3899
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-22 13:44:26 +00:00
Stanislas Sobieski
f32dd09c96 [IMP] odoo_sh doc update
closes odoo/documentation#1607

X-original-commit: 6c48f90739
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-21 17:55:20 +00:00
Odoo Translation Bot
368c905d31 [I18N] Update translation terms from Transifex 2022-02-20 00:30:36 +01:00
Antoine Vandevenne (anv)
913d2c23af [FIX] conf: upper-case 'master' in the version switcher
closes odoo/documentation#1601

X-original-commit: a7f0651773
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-16 12:01:54 +00:00
Elisabeth Dickinson
6e17f7a40b [IMP] odoo_theme: switch admonitions' display type to inline-block
When placing an image before an admonition block and setting its
alignment to left or right, the admonition block would hide the image.
The reason for this is the use of "float" on the image. In order for
the image to reappear, we change the admonition's `display: block` to
`display: inline-block`.

task-2582954

closes odoo/documentation#1592

X-original-commit: c30f2735b8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-15 08:49:24 +00:00
Odoo Translation Bot
1518074e68 [I18N] Update translation terms from Transifex 2022-02-13 00:30:37 +01:00
Antoine Vandevenne (anv)
2cf55fe863 [FIX] conf: list saas-15.2 in existing versions
closes odoo/documentation#1586

X-original-commit: a64e95d1c6
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-11 15:29:53 +00:00
Antoine Vandevenne (anv)
837ee962c2 [IMP] conf: show all relevant versions in the version switcher
From now on, the master branch and the latest released SaaS branch are
always shown. SaaS branches are labeled "Odoo Online".

The list of the versions shown in the switcher is hard-coded to force
their ordering.

The class `dropdown-toggle` is always added to the version|language
switcher regardless of whether other versions|languages are available,
as a quick fix to a CSS issue that occurs when the class is missing.

closes odoo/documentation#1578

X-original-commit: fb469b8211
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-11 14:29:57 +00:00
Jonathan Castillo (jcs)
3d3fee0add [IMP] install/maintain: add info about upgrading Odoo Online databases
closes odoo/documentation#1575

X-original-commit: 5893edda93
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-02-11 10:28:45 +00:00
Antoine Vandevenne (anv)
eed86bf01a [IMP] supported_versions: emphasis short-term support of SaaS versions
X-original-commit: ec8804a1e5
Part-of: odoo/documentation#1575
2022-02-11 10:28:44 +00:00
Antoine Vandevenne (anv)
b772eb62e4 [IMP] supported_versions: flag saas-15.1 as supported
X-original-commit: 04992995a6
Part-of: odoo/documentation#1575
2022-02-11 10:28:44 +00:00
lejeune quentin
ae7868d8ed [ADD] point_of_sale: Connect an Worldline Payment Terminal to your PoS
Documentation to explain how to configure a Worldline Payment terminal.

closes odoo/documentation#1464

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Co-authored-by: perazzo loredana <lrpz@odoo.com>
Co-authored-by: lejeune quentin <qle@odoo.com>
2022-02-10 15:41:49 +00:00
ren-odoo
45726dded7 [IMP] accounting/l10n: update webinar link in colombia.rst
The current webinar link is for another version, with this commit we're adding the newest webinar link.

closes odoo/documentation#1566

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-10 12:28:41 +00:00
StanvanHoorn
c7d8e3ecba [FIX] install/maintain: update versions in "Installing Odoo"
closes odoo/documentation#1242

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-02-09 16:05:16 +00:00
Jonathan Castillo (jcs)
79a33520a1 [FIX] redirections: duplicate rule + misplaced rules
- removes a duplicate rule:
  applications/finance/sign/overview/signature_validity.rst
  applications/finance/sign.rst
- moves two rules closer to their related redirections
- adds comments to these two rules
- updates redirection to "email_servers" with the new path (line 203)

closes odoo/documentation#1553

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-02-07 15:54:48 +00:00
BVE
ce8a02d46a [ADD] email_communication: new documentation regarding general emailing
Creation of a new submenu under Applications/General for the Email communication.
Moved advanced of dicuss to this new submenu + adding of content regarding
frequently asked question in support.

Redirection has been done on other files pointing to Discuss/Advanced to match
the new folder email_communication.

Modified content in:
- Email servers: split and move configuration part under email_domain
- Email domain: covering information about SPF DKIM and DMARC configurations by JQU
- Email templates: (how to use the functions) by GOR
- Email common: answering frequently asked questions + common issues by ALA

closes odoo/documentation#1546

X-original-commit: bf2a9bb23f
Signed-off-by: Vergote Baptiste (bve) <bve@odoo.com>
2022-02-07 11:51:44 +00:00
Odoo Translation Bot
1236938e96 [I18N] Update translation terms from Transifex 2022-02-06 00:30:32 +01:00
Jonathan Castillo (jcs)
dd33c9ad1e [FW][FIX] accounting: fix module name to install in intrastat
closes odoo/documentation#1541

Forward-port-of: odoo/documentation#1539
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-02-04 18:05:07 +00:00
Antoine Vandevenne (anv)
5f1979b7e8 [IMP] contributing/doc: add an entry for the example admonition
closes odoo/documentation#1533

X-original-commit: ddff8f6914
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-04 15:25:17 +00:00
Mathieu Germain
6fb40b61c8 [REF] mrp: documentation update
- Updated Pictures with latest version, deleted old ones
- Added Quality Control section
- Deleted Kit Routings section
- Adapted Terminology, specifically work orders vs routings

closes odoo/documentation#1460

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-03 16:02:48 +00:00
Demesmaeker
3c526a2bc6 [IMP] integration_testing: add information about JS touring
Adding basic information about `How to make a test tour`.

task-2742841

closes odoo/documentation#1517

X-original-commit: 827270c513
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
2022-02-02 13:51:54 +00:00
Niranjan Abhyankar
7ebbd348d8 [FIX] developer/javascript_cheatsheet: fix a typo
closes odoo/documentation#1518

X-original-commit: d9e2ab6feb
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 13:46:19 +00:00
boan-odoo
a9bc16bec8 [IMP] rdtraining: add links from enterprise wiki
Select links and pieces of information from Odoo Enterprise wiki
were copied over at the end Chap. 2 of the functional training.

These would be useful to have during the tutorial instead of at
the end of it.

closes odoo/documentation#1473

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 10:12:01 +00:00
Xavier (xpl)
43cea7a2d2 [ADD] Sign: section on Field Types
Task #: 2585411

closes odoo/documentation#1511

X-original-commit: 7ca24b13ef
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 07:30:45 +00:00
Odoo Translation Bot
f2640a6dba [I18N] Update translation terms from Transifex 2022-01-30 00:30:38 +01:00
Fabien Meghazi
e8af7270ce [IMP] supported_versions: end of support for v10 on Odoo.sh
python2 tooling will be removed gradually
2022-01-29 22:58:47 +01:00
wan
434bb66492 [ADD] extensions: add a custom example admonition
closes odoo/documentation#1503

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-28 11:05:14 +00:00
Jonathan Castillo (jcs)
a22f7cd657 [FIX] redirects.txt: wrong path for outlook doc's redirection
These paths in redirects.txt miss the first folder level, starting from
/content/ .

closes odoo/documentation#1499

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-28 10:04:11 +00:00
Jonathan Castillo (jcs)
7d6757d330 [MOV] payment acquirers: from /general/ (misc. section) to /finance/
The "Payment Acquirers" category was moved to the /general/ folder
(Miscellaneous section) when the super-categories such as "Finance"
didn't exist yet. Now, it makes more sense to move this category to
"Finance".

task-id 2743227

Part-of: odoo/documentation#1499
2022-01-28 10:04:11 +00:00
“Chiara
5b14e76b40 [REM] Accounting: deprecated report removal
Task-id 2744389

closes odoo/documentation#1492

X-original-commit: b34e098551
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-26 17:51:37 +00:00
Jennafer
8938f27820 [FIX] rdtraining: use "deprecate" rather than "depreciate"
Fixed one typo - "depreciated" to "deprecated"

closes odoo/documentation#1490

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-26 14:49:07 +00:00
Antoine Vandevenne (anv)
b97ca3f44d [IMP] paypal: clarify steps to properly configure PayPal
The "Enable IPN" step is also removed because this setting is overruled
by the payment request that Odoo sends to PayPal. Enabling IPN in PayPal
has no effect.

task-2744043

closes odoo/documentation#1480

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-26 14:17:41 +00:00
Olivier Dony
ce62ec91de [FIX] legal/terms: fixups for ES translation of enterprise
closes odoo/documentation#1484

X-original-commit: 69d1d32540
Signed-off-by: Olivier Dony <odo@odoo.com>
2022-01-26 02:22:57 +00:00
Ludvig Auvens
3e1a1a579b [IMP] Legal: spanish translation of enterprise.rst
Task-id: 2501357
X-original-commit: 89042fbe92
Part-of: odoo/documentation#1484
2022-01-26 02:22:57 +00:00
Valentin Chevalier
587b2862df [IMP] payment_stripe: add PM supported by Odoo
Add payment methods supported by Odoo

This will inform users of Stripe which payment method we currently
support.

task-2685143

closes odoo/documentation#1470

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-25 14:49:26 +00:00
Odoo Translation Bot
a869d263b3 [I18N] Update translation terms from Transifex 2022-01-23 00:30:32 +01:00
“Chiara
7ca8564473 [ADD] Accounting: new page about intrastat
Task-id 2721400

closes odoo/documentation#1476

X-original-commit: aa7a78331d
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-01-21 16:04:59 +00:00
Odoo Translation Bot
3e0c934b3c [I18N] Update translation terms from Transifex 2022-01-16 00:30:35 +01:00
Yajo
084fb777f9 [FIX] discuss, cmdline: update for static outgoing mail addresses
This changed for Odoo 15.0 in odoo/odoo#61853 and the docs didn't
reflect that change.

MT-52 @moduon

closes odoo/documentation#1455

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-13 09:50:42 +00:00
Stan
cdb8d51131 [IMP] qweb: mention the two possible syntaxes for t-attf
closes odoo/documentation#1454

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-12 09:43:14 +00:00
Demesmaeker
dfdbf18afa [ADD] general/payment_acquirers: add doc on Ogone Webhook Setup
task-2703230

closes odoo/documentation#1348

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-03 09:52:44 +00:00
Odoo Translation Bot
fc2ceb9e57 [I18N] Update translation terms from Transifex 2021-12-26 00:30:31 +01:00
Paolo (pgi)
69f198e612 [IMP] accounting: add FEC import section to l10n/france
task-id 2573140

closes odoo/documentation#1435

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-21 11:10:47 +00:00
Odoo Translation Bot
f3b5f8aec9 [I18N] Update translation terms from Transifex 2021-12-19 00:30:34 +01:00
Mark Fischer, Jr
f0a6403b32 [FIX] expenses: grammar and typos in expenses.rst
Backport to 13.0 of PR #1175

closes odoo/documentation#1440

X-original-commit: 7090a54670
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-12-17 16:29:51 +00:00
Julien Castiaux
dc832e1cc8 [FIX] developer/reference/javascript_reference
The "qweb key of the manifest" file was still mentionned even if it has
been replaced by the assets bundles.

See related task: 2352566

closes odoo/documentation#1359

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-17 11:06:11 +00:00
Jairo Llopis
53cb375406 [IMP] developer/modules: deprecate 'active' and detail 'auto_install'
1. `active` is just a deprecated field that means exactly the same as
   `auto_install`.
2. `auto_install` can be a list.

See 6cb3140ea8/odoo/modules/module.py (L348-L352)

Original PR: https://github.com/odoo/documentation/pull/1109

closes odoo/documentation#1429

X-original-commit: 03a54e5b37
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 10:46:36 +00:00
poma-odoo
34bc61a3d3 [FIX] developer/rdtraining: comply with the guidelines for report naming
The suggested folder structure does not comply with guidelines:
https://www.odoo.com/documentation/15.0/developer/misc/other/guidelines.html#file-naming

> Concerning printable reports which contain mainly data preparation and Qweb templates naming is
the following :

    addons/plant_nursery/
    |-- report/
    |   |-- plant_order_reports.xml (report actions, paperformat, ...)
    |   |-- plant_order_templates.xml (xml report templates)

closes odoo/documentation#1350

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-03 17:38:11 +00:00
Antoine Vandevenne (anv)
a692dbdc9c [IMP] developer/*: replace occurrences of "access rule" by "record rule"
Both the functional and technical name of the `ir.rule` model is "Record
Rule". This commit makes sure that all occurrences of "Access Rule" are
replaced by the correct name "Record Rule" as it was easily confused
with "Access Rights".

Original PR: https://github.com/odoo/documentation/pull/1118

closes odoo/documentation#1422

X-original-commit: 46cb0b8e9b
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 09:15:49 +00:00
TwioTech
87faaaf02c [IMP] PoS: six payment method configuration
closes odoo/documentation#1331

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: LoredanaLrpz <lrpz@odoo.com>
2021-12-15 11:03:37 +00:00
Adrien Minne
9d45b861c0 [FIX] rdtraining: fix wrong suggested folder for views
The training suggests to put the views in the data/ folder instead of the views/ folder

closes odoo/documentation#1349

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-14 16:53:44 +00:00
Tymoteusz Motylewski
a8fe35665b [IMP] backend/testing: add link to unittest python library
closes odoo/documentation#1414

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-14 12:08:51 +00:00
Chris Parker
c6cbaee4aa [FIX] api/odoo: reflect the correct location of menu actions
closes odoo/documentation#1411

X-original-commit: beb92c9f18
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-14 12:08:48 +00:00
Perman Atayev
fccd2bf235 [IMP] install/maintain: fix a typo
original commit 5098eaf93f
in PR https://github.com/odoo/documentation/pull/1345/

closes odoo/documentation#1406

X-original-commit: 806a96f8cb
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-12-13 18:11:14 +00:00
Xavier
1b5afa3d18 [IMP] studio: fix a typo
Original commit: e1e644fc9a
in PR: #1330

closes odoo/documentation#1401

X-original-commit: a1db25d3ba
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-12-13 10:14:51 +00:00
luxiaochuang
cf1504258e [FIX] howtos: remove useless <group/> tag from training example
closes odoo/documentation#1369

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-10 15:57:17 +00:00
mdb-odoo
fdeff4d4f0 [IMP] inventory: push/pull explanations
forward-port of e946f5fcfd
original commit (never merged) 427b14dcae

closes odoo/documentation#1391

X-original-commit: 71fe1e09ee
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-12-09 15:55:58 +00:00
jedgalbraith
7f80848e54 [IMP] sales: grammar fix
closes odoo/documentation#1387

X-original-commit: 4903a9fecc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-12-09 15:34:08 +00:00
jedgalbraith
0a83b1ebea [IMP] inventory: word mistake
closes odoo/documentation#1383

X-original-commit: 5d72b5028f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-12-09 15:07:46 +00:00
Antoine Vandevenne (anv)
ca4f2cd2b2 [IMP] README: remove request for review instruction
closes odoo/documentation#1377

X-original-commit: 493ebbfa9a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-09 13:38:12 +00:00
Antoine Vandevenne (anv)
67272252e7 [REM] CODEOWNERS: rely on runbot's codeowners system
closes odoo/documentation#1372

X-original-commit: edddeb4826
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-09 12:24:03 +00:00
Moens Alexandre
cca654e4d9 [IMP] hosting change: from PaaS to SaaS
Requesting a dump from the customers comming from the PaaS is useless
(since support has access to the odoo.sh projects) and counter
productive (since it only makes the migration outage longer while the
customer downloads the file, then uploads it, then we download it,
instead of just the support downloading it)

closes odoo/documentation#1366

X-original-commit: c3c054681c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-12-08 13:54:12 +00:00
Morgane Demesmaeker
8bfa68e930 [IMP] general/payment_acquirers: rename and swap some headings
closes odoo/documentation#1227

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-08 09:17:04 +00:00
Demesmaeker
92ad3e8658 [ADD] general/payment_acquirers: add doc on Stripe Webhook Setup
and ease the way to get the api keys

task-2574512

closes odoo/documentation#1335

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-02 15:30:41 +00:00
Rémy Baranx (bar)
57e1e31433 [FIX] conf.py: check odoo_dir is a real Odoo sources dir
In `conf.py`, we try to find a Odoo sources folder among `odoo` and
`../odoo` directories without really checking that they really are
Odoo sources folders, leading to doc generation error if it's not the case.

So, to improve that, this commit checks that the selected Odoo sources folder
contains `odoo-bin`.

While we're at it, the logging is also improved to always display the
matching odoo sources' folder and version.

closes odoo/documentation#1340

X-original-commit: f72e557f2c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne <anv@odoo.com>
2021-11-29 10:59:09 +00:00
lejeune quentin
afa905b9c4 [FIX] point_of_sale: Update certificate import
With the new version of chrome 95 we need adapt the documentation

closes odoo/documentation#1318

X-original-commit: 0f1f90e486
Signed-off-by: Quentin Lejeune (qle) <qle@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-22 07:58:58 +00:00
Géry Debongnie
8c1003e363 [IMP] developer: small rework of assets page (frontend)
This commit applies some remarks by Antoine.

closes odoo/documentation#1327

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-19 13:24:53 +00:00
luvi
1f84bab97d [ADD] developer: scroller service added
This commit adds the documentation related to
the scroller service. This service is used for
the webclient to handle clicks on links and there
were no documentation related until now.

closes odoo/documentation#1313

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-19 11:36:52 +00:00
Zachary Straub (ZST)
0653e3df58 [IMP] finance: remove fiscal localization countries screenshots
closes odoo/documentation#1311

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-17 11:17:49 +00:00
Antoine Dupuis (andu)
15a1f73c28 [IMP] accounting/taxcloud: how to set up default account for new taxes
New taxes generated by the TaxCloud integration are by default created without an income or an expense account specified. By default, the journal items corresponding to these taxes therefore end up in the default income account, which is usually the 'Sales' account, when they should in fact go to the 'Tax Payable' account. Because these taxes are automatically generated on-the-fly, the user is usually not able to manually specify the Tax Payable account before the journal items are posted, leading to incorrect accounting entries which then need to be manually repaired through the use of miscellaneous operations.

To solve this issue, our video on TaxCloud integration (https://www.youtube.com/watch?v=JE-NeRNIWeU&t=616s) tells us to create a User-Defined Default for the account field of the tax.repartition.line model. This sets the default account with which new taxes are created. However, this information is missing from the documentation.

This PR brings the documentation up-to-date by explaining how to create this User-Defined Default that specifies the correct Tax Payable account.

closes odoo/documentation#1321

X-original-commit: 35d773a82a
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-17 09:50:08 +00:00
Valentin Chevalier
e062a7c816 [ADD] product_images: add a tutorial
This will help users to get automatically images for their products.

task-2558054

closes odoo/documentation#1007

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-15 15:18:39 +00:00
Géry Debongnie
d761910466 [IMP] developer: list content of browser object (js)
closes odoo/documentation#1310

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-15 09:25:07 +00:00
Bruno Boi
43d838d826 [IMP] developer: more info for usePosition JS hook
closes odoo/documentation#1305

Signed-off-by: Bruno Boi <boi@odoo.com>
2021-11-10 14:21:21 +00:00
lejeune quentin
7c0c6c44bf [ADD] point_of_sale: self-signed certificate for epos printers
Add documentation to explain how to use a ePos printer in HTTPS

closes odoo/documentation#1307

X-original-commit: f8f93ec288
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-11-09 17:11:42 +00:00
Simon Genin (ges)
bbc85e148e [ADD] developer: add js http service
closes odoo/documentation#1293

Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-11-09 16:56:01 +00:00
Géry Debongnie
624131f712 [IMP] developer: document formatters/parsers registries
and add entry for effects registry as well

closes odoo/documentation#1300

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-08 16:00:37 +00:00
Géry Debongnie
8c79319011 [IMP] developer: rewrite the page on assets
closes odoo/documentation#1299

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-08 15:56:49 +00:00
Géry Debongnie
11171da6b1 [IMP] developer: add section on router service
closes odoo/documentation#1292

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-05 14:15:36 +00:00
Géry Debongnie
d551193391 [IMP] developer: add missing links in js doc
and slightly improve effect registry page

closes odoo/documentation#1296

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-05 10:12:35 +00:00
Raf Geens
43193d6749 [FIX] testing: Explain "new" tagging syntax
Syntax was added to explicitly specify a module, class or function with
`--test-tags`: b729a11a12

The documentation was not updated to reflect this, leading to confusion
as people tried to reconcile the documentation with the actual behavior,
without necessarily having seen `odoo-bin --help` which is explicit
about it.

closes odoo/documentation#1281

X-original-commit: 77dd769b08
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Raf Geens <raf@odoo.com>
2021-11-05 08:57:44 +00:00
Géry Debongnie
894165a949 [IMP] developer: normalize reference in js doc
The preferred format for (frontend) references is now:
"frontend/filename/section", or something close to that.

closes odoo/documentation#1291

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-04 13:43:37 +00:00
Géry Debongnie
b48f0cbad8 [IMP] developer: rework section on debug mode
closes odoo/documentation#1280

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-03 20:01:46 +00:00
Géry Debongnie
da4dae597e [IMP] developer: add sections on pyjs and domains
closes odoo/documentation#1248

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-03 19:48:26 +00:00
Géry Debongnie
f206233ebc [MOV] developer: move section on patching javascript
This commit is a move, but the content was also slightly
updated/reformatted.

closes odoo/documentation#1244

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-03 17:48:14 +00:00
Géry Debongnie
91f97aff54 [IMP] developer: add Dropdown documentation
joint work with Bruno (boi)

closes odoo/documentation#1247

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-03 16:26:55 +00:00
Jonathan Castillo (jcs)
94b26c5fe0 [IMP] website: update a wrong link (godaddy)
task-id 2682327

closes odoo/documentation#1285

X-original-commit: edb747bca1
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-11-03 16:16:45 +00:00
Christophe Monniez
cbd85f1f47 [FIX] Makefile: call pysassc from python module
pysassc utility is called in the Makefile. On some system (e.g.: the latest
Dockerfile of the runbot) this utility cannot be found in the system's
paths.

As the pysassc utility is a wrapper for the python module, we can simply
call the python module by it's entrypoint.

Also, this commit fixes the requirements as the pysass package was
installed to incidentally install libsass.

closes odoo/documentation#1269

Signed-off-by: Christophe Monniez (moc) <moc@odoo.com>
2021-11-03 11:04:17 +00:00
Antoine Vandevenne (anv)
8425ddc444 [FIX] requirements.txt: Let sphinx manage docutils version
As of sphinx 3.5.4, docutils >0.17 is no longer supported. To avoid
forcing the install of an unsupported version of docutils, we let
sphinx install the appropriate version through its dependencies.

closes odoo/documentation#1275

X-original-commit: 116d9b5181
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-03 10:45:25 +00:00
Simon Genin (ges)
05a0a49a20 [IMP] js: js domain css customization
closes odoo/documentation#1206

Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-11-03 09:19:09 +00:00
Simon Genin (ges)
d72c3fdd8b [ADD] developer: effect service
closes odoo/documentation#1210

Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-11-03 09:00:43 +00:00
Géry Debongnie
1e6c12be30 [IMP] developer: improve section on env
- add a link to services
- add a note that the env is quite powerful
- reformat the table with the list-table role, to make it easier to edit

closes odoo/documentation#1249

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-03 08:36:04 +00:00
Géry Debongnie
4082906776 [IMP] developer: reorder and improve notification service
closes odoo/documentation#1265

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-03 08:25:52 +00:00
Géry Debongnie
b4fce0a13d [IMP] developer: add section on cookie service
and slightly improve notification information

closes odoo/documentation#1241

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-02 19:55:52 +00:00
Géry Debongnie
f564487e56 [IMP] developer: add section on debug mode (js)
closes odoo/documentation#1250

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-02 19:12:36 +00:00
Géry Debongnie
ce96d6c584 [IMP] developer: use js domain for registry page
This commit update the registry documentation to use the js domain
directives instead of trying to format functions with code blocks.

I am not impressed with the way it looks, but in any cases, it is
certainly better to properly structure the documentation.

closes odoo/documentation#1245

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-02 14:32:57 +00:00
Géry Debongnie
a2a389688c [FIX] developer: document assets key in manifest, remove old info
This commit adds a pretty important missing piece of information: the
assets key in the manifest. At the same time, we remove two keys that
are no longer in use.

closes odoo/documentation#1251

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-02 14:17:58 +00:00
Géry Debongnie
06b6c18972 [MOV] developer: move assets doc into frontend
Now that the reference is split into backend/frontend, it makes more
sense to have the assets page into the frontend section.

closes odoo/documentation#1243

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-02 13:42:38 +00:00
Géry Debongnie
a76e505892 [IMP] developer: rename addons/js => backend/frontend
The terminology did not really make sense for a lot of these sub pages.
This change should have been done long ago, but was probably delayed
because some people in Odoo call the web client the "backend", which is
really misleading.

This commit also renames the title "Reference Guides" to "Reference",
since this section does not contain any guides anyway.

Part-of: odoo/documentation#1243
2021-11-02 13:42:38 +00:00
Martin Trigaux
4fb6c72d75 [FIX] conf: allow to build on python 3.6
Since odoo/odoo@794677fb6a Odoo requires python 3.7 min.
However, it still runs fine in 3.6 and this is the python version of
the build server.
Fake the version to be able to build the doc on the nightly server.

To be removed once the nightly server is migrated.

closes odoo/documentation#1257

Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2021-11-02 13:33:59 +00:00
Géry Debongnie
a8172fa67a [IMP] developer: add section on user menu registry (js)
closes odoo/documentation#1246

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-02 11:07:54 +00:00
Géry Debongnie
a4a0f65c5d [IMP] developer: add sections on service and systray registry
Part-of: odoo/documentation#1246
2021-11-02 11:07:54 +00:00
frln
26042f541a [IMP] administration/install, *: make 3.7 the minimum version for Python
As of commit https://github.com/odoo/odoo/commit/794677fb Python 3.7 is
the minimum required version for Python when running Odoo 15.0.

This also applies to building the version 15.0 of the documentation.

closes odoo/documentation#1218

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-02 10:51:49 +00:00
Michael (mcm)
1ea99ca48c [IMP] developer/views: update map doc
This commit updates the documentation of the map view.
There were missing map attributes, typos and wrong descriptions.

closes odoo/documentation#1253

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-02 10:22:14 +00:00
Martin Trigaux
bd2fe4a6fe [I18N] *: export 15.0 translations 2021-11-02 10:26:17 +01:00
Simon Genin (ges)
363e5446b5 [ADD] developer: notification service
closes odoo/documentation#1233

Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-10-29 12:45:25 +00:00
Simon Genin (ges)
eca14b6620 [Add] developer: add section on js title service
closes odoo/documentation#1230

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-29 12:19:44 +00:00
Géry Debongnie
05ab4a7b0a [IMP] developer: add information on bus (js)
and move the section on environment to the framework main documentation
page.

closes odoo/documentation#1228

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-29 10:22:49 +00:00
Simon Genin (ges)
1757e01eca [Add] developer: add js user service
closes odoo/documentation#1202

Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-10-29 07:45:02 +00:00
Géry Debongnie
9b02ea8474 [IMP] developer: add section on context in js framework page
closes odoo/documentation#1225

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-28 09:37:41 +00:00
Géry Debongnie
eea6a94411 [ADD] developer: add a reference page on hooks (js)
closes odoo/documentation#1208

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-26 11:13:21 +00:00
Géry Debongnie
8bdbb415b5 [ADD] developer: add page on generic components (js)
closes odoo/documentation#1209

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-26 08:43:38 +00:00
Jonathan Castillo (jcs)
2aeffd3950 [ADD] maintain: revert and update "db_online"
task-2601835

closes odoo/documentation#1220

X-original-commit: d7f4475901
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-25 14:08:08 +00:00
Géry Debongnie
e19e13606b [MOV] developer: move assets doc into its own page
closes odoo/documentation#1196

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-22 13:39:37 +00:00
Julien Van Roy
1e284a4455 [FIX] developer/reference: fix missing slash in javascript/qweb, debugging section
closes odoo/documentation#1214

X-original-commit: 7fbf1c3ef2
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-22 13:18:42 +00:00
Géry Debongnie
a5a669a5eb [ADD] developer: add new page on registries (js)
closes odoo/documentation#1193

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-22 13:13:51 +00:00
Géry Debongnie
ddad75982f [ADD] developer: add page on services (js)
closes odoo/documentation#1194

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-22 12:48:55 +00:00
Géry Debongnie
c6f813f4cb [ADD] developer: add javascript module page
This commit moves most of the content out of the javascript reference
and into a more visible page.

closes odoo/documentation#1192

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-22 12:33:05 +00:00
lejeune quentin
8f7695b8ba [ADD] point_of_sale: configure https in the POS
The default protocol int the POS with "other device"
is on HTTP.

This doc explain how to activate the HTTPS in the POS

closes odoo/documentation#1204

X-original-commit: a160504b8d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-21 11:02:47 +00:00
Olivier Dony
d679d45769
[ADD] legal/license: update licenses for v15 2021-10-20 11:26:49 +02:00
Olivier Dony
b21528bd7b
[FIX] legal/terms: fr: simplify limitation of liability
The english version has a confusing wording, using "strict ngligence"
instead of "strict liability" in this sentence:
  "(...) regardless of the form of action, whether in contract, tort
   (including strict negligence) or any other legal (...)"

In FR/BE this would seeem to refer to the notion of "responsabilité
objective" ou "responsabilité sans faute".

Yet this extra precision seems confusing and does not seem to add to the
already broad clause. It seems simpler to omit it.

The typical english wording for this clause is simply:
"regardless of the form of action, whether in contract, tort or otherwise".
2021-10-20 11:20:29 +02:00
Olivier Dony
9ddd60de3e
[CHG] legal/tos: specify pricelist for global customers 2021-10-20 11:15:42 +02:00
Antoine Vandevenne (anv)
b697bf28b7 [FIX] extract_api: bring back extract_api doc lost with be1653cc
closes odoo/documentation#1198

X-original-commit: 59df6b90ae
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-20 07:38:51 +00:00
Géry Debongnie
b4e8e475f0 [ADD] developer: add page on owl component system
closes odoo/documentation#1178

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-15 15:00:57 +00:00
Géry Debongnie
ff5a50856f [ADD] developer: add javascript framework overview
closes odoo/documentation#1181

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-15 14:32:39 +00:00
Jonathan Castillo (jcs)
7b1b1c795d [IMP] upgrade: create new "upgrade" section in "install and maintain"
closes odoo/documentation#1186

X-original-commit: fd006b4a3c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Jonathan <jcs-odoo@users.noreply.github.com>
2021-10-15 11:45:14 +00:00
Jonathan Castillo (jcs)
00df7aee21 [IMP] maintain: on premise filename change and media movement
X-original-commit: 8ca7d66faa
Part-of: odoo/documentation#1186
2021-10-15 11:45:14 +00:00
Jonathan Castillo (jcs)
b1099e2218 [IMP] maintain: update versions upgrade
task-2600310

X-original-commit: 84ceee3fda
Part-of: odoo/documentation#1186
2021-10-15 11:45:13 +00:00
Olivier Dony
a8c58815f3 [FIX] mail_plugins: fix outlook plugin url
The outlook plugin (v2.0.0) for v15 is not compatible with
older databases, so we need both version to be hosted
separately, and therefore a new URL.
2021-10-13 19:39:43 +02:00
Valentin Chevalier (vcr)
a4aa310b85 [FIX] payment_acquirers/paypal: broken link
Users couldn't click on Paypal and saw the HTTP link instead of only 'Paypal'

closes odoo/documentation#1174

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-12 14:36:49 +00:00
Xavier
4331177bb6 [IMP] mail plugins: improve the naming consistency of plugins
The plugins were named "Odoo-Gmail Plugin" / "Gmail Plugin" and "Odoo-Outlook Plugin" /
"Outlook Plugin". I chose the later version for both plugins consistently.
I also added a reference to both the Gmail and Outlook docs in the main Mail Plugins doc.

closes odoo/documentation#1170

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-11 09:39:43 +00:00
Xavier
debe8cb393 [IMP] mail plugins: add gmail plugin + update and move outlook plugin
Task ID: 2662764

closes odoo/documentation#1167

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-07 18:23:02 +00:00
Demesmaeker
3a2bbc028b [IMP] payment_acquirers: revamp online payment providers' documentation
task-2654702

closes odoo/documentation#1061

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-05 17:24:43 +00:00
Antoine Vandevenne (anv)
b28e34b357 [REL] supported_versions: update list of versions and add end of support
closes odoo/documentation#1162

X-original-commit: e0c70eb5ff
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-05 15:17:53 +00:00
Antoine Vandevenne (anv)
c107d76086 [IMP] contributing: adapt the GitHub workflow to the new doc theme
closes odoo/documentation#1159

X-original-commit: 8043d92b24
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-05 14:23:56 +00:00
Antoine Vandevenne (anv)
b118669860 [REL] freeze 15.0 branch 2021-10-05 13:50:03 +02:00
Denis Ledoux
3218d318fe [FIX] maintain: upgrade command line link
closes odoo/documentation#1150

X-original-commit: 7276929071
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-09-22 10:37:59 +00:00
Tiffany Chang (tic)
bb3996b936 [IMP] developer/{howtos,reference}: update training to match v15 changes
- Reference v15 training solutions
- Refer to Command namespace instead of triplets (e.g.
  Command.create(values) instead of (0, 0, values)
- Add notice about OWL transition
- Add reference to @api.ondelete (instead of override unlink())
- Remove references to SavepointCase (now only TransactionCase) from
  unit test topic

- Also add missing reference documentation for ondelete

closes odoo/documentation#1146

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-09-20 11:47:42 +00:00
Tiffany Chang (tic)
b3845ae0d8 [IMP] developer/howtos: proofread adv topics
- Cleaned up the language a tiny bit
- Fixed small errors/typos
- Add some missing info for dashboard topic
- Updated unit test exercise to match what's in the solutions repo

Part-of: odoo/documentation#1146
2021-09-20 11:47:42 +00:00
Tiffany Chang (tic)
85410bd8dc [IMP] developer/howtos: encourage linters more
There have been complaints of newbies not setting up their linters
therefore let's emphasize their use/setup more in the tutorial and hope
for the best.

Part-of: odoo/documentation#1146
2021-09-20 11:47:42 +00:00
Jonathan Castillo (jcs)
248135a48e [IMP] maintain: update test doc link in versions upgrade
closes odoo/documentation#1141

X-original-commit: 0842b682fc
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-09-14 16:23:07 +00:00
Raf Geens
6833379ad3 [FIX] app/accounting: Fix outdated Colombian test server url
The test server url for Carvajal T&S was out of date and has been
updated with the correct one. Carvajal has also split into 2
different companies, with new customers using the new company (CSC)
by default but the older company (CTS) still being available for
existing customers. See task 2508208. So the documentation was
updated to include both of them.

CTS (Carvajal T&S) was being used to refer to Carvajal in general,
so to avoid confusion those mentions have been changed to just
"Carvajal" since it can refer to either CTS or CSC.

closes odoo/documentation#1138

X-original-commit: 396df2abdd
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-09-14 16:18:51 +00:00
Jonathan Castillo (jcs)
00046cb690 [FIX] subscriptions: wrong Odoo Tutorials link
task-2636416

closes odoo/documentation#1136

X-original-commit: ebf216cc8e
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-09-14 12:31:13 +00:00
Antoine Vandevenne (anv)
ac40d2008c [IMP] conf: hide saas branches from the version switcher 2021-09-09 17:22:27 +02:00
Antoine Vandevenne (anv)
5cef86f181 [REL] freeze saas-14.5 branch 2021-09-09 16:25:46 +02:00
482 changed files with 67763 additions and 70079 deletions

11
.github/CODEOWNERS vendored
View File

@ -1,11 +0,0 @@
# All changes to technical files (build environment and Sphinx extensions) have to be approved
/extensions/ @odoo/doc-review
.gitignore @odoo/doc-review
commit_template.txt @odoo/doc-review
conf.py @odoo/doc-review
Makefile @odoo/doc-review
requirements.txt @odoo/doc-review
# All changes to legal material have to be approved
/content/legal/ @odoo/legal
/content/legal.rst @odoo/legal

View File

@ -2,62 +2,62 @@
host = https://www.transifex.com
type = PO
[odoo-14-doc.applications]
[odoo-15-doc.applications]
file_filter = locale/<lang>/LC_MESSAGES/applications.po
source_file = locale/sources/applications.pot
source_lang = en
[odoo-14-doc.finance]
[odoo-15-doc.finance]
file_filter = locale/<lang>/LC_MESSAGES/finance.po
source_file = locale/sources/finance.pot
source_lang = en
[odoo-14-doc.general]
[odoo-15-doc.general]
file_filter = locale/<lang>/LC_MESSAGES/general.po
source_file = locale/sources/general.pot
source_lang = en
[odoo-14-doc.index]
[odoo-15-doc.index]
file_filter = locale/<lang>/LC_MESSAGES/index.po
source_file = locale/sources/index.pot
source_lang = en
[odoo-14-doc.inventory_and_mrp]
[odoo-15-doc.inventory_and_mrp]
file_filter = locale/<lang>/LC_MESSAGES/inventory_and_mrp.po
source_file = locale/sources/inventory_and_mrp.pot
source_lang = en
[odoo-14-doc.marketing]
[odoo-15-doc.marketing]
file_filter = locale/<lang>/LC_MESSAGES/marketing.po
source_file = locale/sources/marketing.pot
source_lang = en
[odoo-14-doc.productivity]
[odoo-15-doc.productivity]
file_filter = locale/<lang>/LC_MESSAGES/productivity.po
source_file = locale/sources/productivity.pot
source_lang = en
[odoo-14-doc.sales]
[odoo-15-doc.sales]
file_filter = locale/<lang>/LC_MESSAGES/sales.po
source_file = locale/sources/sales.pot
source_lang = en
[odoo-14-doc.services]
[odoo-15-doc.services]
file_filter = locale/<lang>/LC_MESSAGES/services.po
source_file = locale/sources/services.pot
source_lang = en
[odoo-14-doc.theme]
[odoo-15-doc.theme]
file_filter = locale/<lang>/LC_MESSAGES/sphinx.po
source_file = locale/sources/sphinx.pot
source_lang = en
[odoo-14-doc.user_settings]
[odoo-15-doc.user_settings]
file_filter = locale/<lang>/LC_MESSAGES/settings.po
source_file = locale/sources/settings.pot
source_lang = en
[odoo-14-doc.websites]
[odoo-15-doc.websites]
file_filter = locale/<lang>/LC_MESSAGES/websites.po
source_file = locale/sources/websites.pot
source_lang = en

View File

@ -24,7 +24,7 @@ SOURCE_DIR = content
HTML_BUILD_DIR = $(BUILD_DIR)/html
ifdef VERSIONS
HTML_BUILD_DIR := $(HTML_BUILD_DIR)/master
HTML_BUILD_DIR := $(HTML_BUILD_DIR)/15.0
endif
ifneq ($(CURRENT_LANG),en)
HTML_BUILD_DIR := $(HTML_BUILD_DIR)/$(CURRENT_LANG)
@ -69,7 +69,7 @@ gettext:
$(HTML_BUILD_DIR)/_static/style.css: extensions/odoo_theme/static/style.scss extensions/odoo_theme/static/scss/*.scss
@echo "Compiling stylesheets..."
mkdir -p $(HTML_BUILD_DIR)/_static
pysassc extensions/odoo_theme/static/style.scss $(HTML_BUILD_DIR)/_static/style.css
python3 -m pysassc extensions/odoo_theme/static/style.scss $(HTML_BUILD_DIR)/_static/style.css
@echo "Compilation finished."
#=== Development and debugging rules ===#

View File

@ -4,11 +4,11 @@
### Requirements
- [Git](https://www.odoo.com/documentation/master/contributing/documentation.html#install-git)
- [Python 3.6, 3.7, or 3.8](https://www.odoo.com/documentation/master/contributing/documentation.html#python)
- Python dependencies listed in the file [`requirements.txt`](https://github.com/odoo/documentation/tree/master/requirements.txt).
- [Make](https://www.odoo.com/documentation/master/contributing/documentation.html#make)
- A local copy of the [odoo/odoo repository in master](https://github.com/odoo/odoo/tree/master) (Optional)
- [Git](https://www.odoo.com/documentation/15.0/contributing/documentation.html#install-git)
- [Python 3.7 or 3.8](https://www.odoo.com/documentation/15.0/contributing/documentation.html#python)
- Python dependencies listed in the file [`requirements.txt`](https://github.com/odoo/documentation/tree/15.0/requirements.txt).
- [Make](https://www.odoo.com/documentation/15.0/contributing/documentation.html#make)
- A local copy of the [odoo/odoo repository in 15.0](https://github.com/odoo/odoo/tree/15.0) (Optional)
### Instructions
@ -23,7 +23,7 @@
2. Open the file `documentation/_build/html/index.html` in your web browser to display the render.
3. See [this guide](https://www.odoo.com/documentation/master/contributing/documentation.html#preview-your-changes)
3. See [this guide](https://www.odoo.com/documentation/15.0/contributing/documentation.html#preview-your-changes)
for more detailed instructions.
Optional: to fully build the developer documentation with inline docstrings for documented Python
@ -34,15 +34,11 @@ be shown.
## Contribute to the documentation
For contributions to the content of the documentation, please refer to the
[Introduction Guide](https://www.odoo.com/documentation/master/contributing/documentation.html).
[Introduction Guide](https://www.odoo.com/documentation/15.0/contributing/documentation.html).
To **report a content issue**, **request new content** or **ask a question**, use the
[repository's issue tracker](https://github.com/odoo/documentation-user/issues) as usual.
If you have a pull request that is ready for review, request one from the
[odoo/doc-review](https://github.com/orgs/odoo/teams/doc-review) team.
## Learn More
To learn more about Odoo, in addition to the documentation, have a look at

122
conf.py
View File

@ -19,7 +19,7 @@ copyright = 'Odoo S.A.'
# `version` if the version info for the project being documented, acts as replacement for |version|,
# also used in various other places throughout the built documents.
# `release` is the full version, including alpha/beta/rc tags. Acts as replacement for |release|.
version = release = 'master'
version = release = '15.0'
# The minimal Sphinx version required to build the documentation.
needs_sphinx = '3.0.0'
@ -58,34 +58,44 @@ extension_dir = Path('extensions')
sys.path.insert(0, str(extension_dir.absolute()))
# Search for the directory of odoo sources to know whether autodoc should be used on the dev doc
odoo_dir = Path('odoo')
odoo_sources_candidate_dirs = (Path('odoo'), Path('../odoo'))
odoo_sources_dirs = [
d for d in odoo_sources_candidate_dirs if d.is_dir() and (d / 'odoo-bin').exists()
]
odoo_dir_in_path = False
if not odoo_dir.is_dir():
parent_odoo_dir = Path('../odoo')
if parent_odoo_dir.is_dir():
_logger.info('Using parent dir to find odoo sources')
odoo_dir = parent_odoo_dir
if not odoo_dir.is_dir():
if not odoo_sources_dirs:
_logger.warning(
f"Could not find Odoo sources directory at {odoo_dir.absolute()}.\n"
f"The 'Developer' documentation will be built but autodoc directives will be skipped.\n"
f"In order to fully build the 'Developer' documentation, clone the repository with "
f"`git clone https://github.com/odoo/odoo` or create a symbolink link."
"Could not find Odoo sources directory in neither of the following folders:\n"
"%(dir_list)s\n"
"The 'Developer' documentation will be built but autodoc directives will be skipped.\n"
"In order to fully build the 'Developer' documentation, clone the repository with "
"`git clone https://github.com/odoo/odoo` or create a symbolic link.",
{'dir_list': '\n'.join([f'\t- {d.resolve()}' for d in odoo_sources_candidate_dirs])},
)
else:
sys.path.insert(0, str(odoo_dir.absolute()))
odoo_dir = odoo_sources_dirs[0].resolve()
sys.path.insert(0, str(odoo_dir))
if (3, 6) < sys.version_info < (3, 7):
# Running odoo needs python 3.7 min but monkey patch version_info to be compatible with 3.6
sys.version_info = (3, 7, 0)
from odoo import release as odoo_release # Don't collide with Sphinx's 'release' config option
odoo_version = odoo_release.version if 'alpha' not in odoo_release.version else 'master'
odoo_version = odoo_release.version.replace('~', '-') \
if 'alpha' not in odoo_release.version else 'master'
if release != odoo_version:
_logger.warning(
f"Found Odoo sources directory but with version '{odoo_version}' incompatible with "
f"documentation version '{version}'.\n"
f"The 'Developer' documentation will be built but autodoc directives will be skipped.\n"
f"In order to fully build the 'Developer' documentation, checkout the matching branch"
f" with `cd odoo && git checkout {version}`."
"Found Odoo sources in %(directory)s but with version '%(odoo_version)s' incompatible "
"with documentation version '%(doc_version)s'.\n"
"The 'Developer' documentation will be built but autodoc directives will be skipped.\n"
"In order to fully build the 'Developer' documentation, checkout the matching branch"
" with `cd odoo && git checkout %(doc_version)s`.",
{'directory': odoo_dir, 'odoo_version': odoo_version, 'doc_version': version},
)
else:
_logger.info(f"Found Odoo sources directory matching documentation version {release}.")
_logger.info(
"Found Odoo sources in %(directory)s matching documentation version '%(version)s'.",
{'directory': odoo_dir, 'version': release},
)
odoo_dir_in_path = True
# The Sphinx extensions to use, as module names.
@ -106,7 +116,7 @@ extensions = [
# Youtube and Vimeo videos integration (youtube, vimeo directives)
'embedded_video',
'exercise_admonition',
'custom_admonitions',
# Redirection generator
'redirects',
@ -114,9 +124,13 @@ extensions = [
# Code switcher (switcher and case directives)
'switcher',
# Content tabs
'sphinx_tabs.tabs',
# Strange html domain logic used in memento pages
'html_domain',
]
if odoo_dir_in_path:
# GitHub links generation
extensions += [
@ -142,7 +156,20 @@ sphinx.transforms.i18n.docname_to_domain = (
sphinx.util.i18n.docname_to_domain
) = lambda docname, compact: docname.split('/')[1 if docname.startswith('applications/') else 0]
supported_languages = {
# The version names that should be shown in the version switcher, if the config option `versions`
# is populated. If a version is passed to `versions` but is not listed here, it will not be shown.
versions_names = {
'master': "Master",
'saas-15.2': "Odoo Online",
'saas-15.1': "Odoo Online",
'15.0': "Odoo 15",
'14.0': "Odoo 14",
'13.0': "Odoo 13",
}
# The language names that should be shown in the language switcher, if the config option `languages`
# is populated. If a language is passed to `languages` but is not listed here, it will not be shown.
languages_names = {
'de': 'Deutsch',
'en': 'English',
'es': 'Español',
@ -156,6 +183,9 @@ supported_languages = {
# The specifications of redirect rules used by the redirects extension.
redirects_file = 'redirects.txt'
sphinx_tabs_disable_tab_closing = True
sphinx_tabs_disable_css_loading = False
#=== Options for HTML output ===#
html_theme = 'odoo_theme'
@ -180,7 +210,7 @@ html_permalinks = True # Sphinx >= 3.5
# Additional JS & CSS files that can be imported with the 'custom-js' and 'custom-css' metadata.
# Lists are empty because the files are specified in extensions/themes.
html_js_files = []
html_css_files = []
html_css_files = ["css/js.css"]
# PHP lexer option to not require <?php
highlight_options = {
@ -283,15 +313,18 @@ def _generate_alternate_urls(app, pagename, templatename, context, doctree):
The entry 'version' is added by Sphinx in the rendering context.
"""
# If the list of versions is not set, assume that the project has no alternate version
_alternate_versions = app.config.versions and app.config.versions.split(',') or []
context['alternate_versions'] = [
(_alternate_version, _build_url(_version=_alternate_version))
for _alternate_version in sorted(_alternate_versions, reverse=True)
if _alternate_version != version and (
_alternate_version != 'master' or pagename.startswith('developer')
)
]
context['version_display_name'] = versions_names[version]
# If the list of versions is not set, assume the project has no alternate version
_provided_versions = app.config.versions and app.config.versions.split(',') or []
# Map alternate versions to their display names and URLs.
context['alternate_versions'] = []
for _alternate_version, _display_name in versions_names.items():
if _alternate_version in _provided_versions and _alternate_version != version:
context['alternate_versions'].append(
(_display_name, _build_url(_alternate_version))
)
def _localize():
""" Add the pairs of (lang, code, url) for the current document in the rendering context.
@ -302,19 +335,22 @@ def _generate_alternate_urls(app, pagename, templatename, context, doctree):
"""
_current_lang = app.config.language or 'en'
# Replace the context value by its translated description ("Français" instead of "french")
context['language'] = supported_languages.get(_current_lang)
context['language'] = languages_names.get(_current_lang)
# If the list of languages is not set, assume that the project has no alternate language
_alternate_languages = app.config.languages and app.config.languages.split(',') or []
context['alternate_languages'] = [
(
supported_languages.get(_alternate_lang),
_alternate_lang.split('_')[0] if _alternate_lang != 'en' else 'x-default',
_build_url(_lang=_alternate_lang),
)
for _alternate_lang in _alternate_languages
if _alternate_lang in supported_languages and _alternate_lang != _current_lang
]
_provided_languages = app.config.languages and app.config.languages.split(',') or []
# Map alternate languages to their display names and URLs.
context['alternate_languages'] = []
for _alternate_lang, _display_name in languages_names.items():
if _alternate_lang in _provided_languages and _alternate_lang != _current_lang:
context['alternate_languages'].append(
(
_display_name,
_alternate_lang.split('_')[0] if _alternate_lang != 'en' else 'x-default',
_build_url(_lang=_alternate_lang),
)
)
def _build_url(_version=None, _lang=None):
if app.config.is_remote_build:

View File

@ -18,4 +18,5 @@ These guides provide instructions on how to install, maintain and upgrade Odoo d
administration/install
administration/maintain
administration/upgrade
administration/odoo_sh

View File

@ -4,6 +4,8 @@
Install
=======
.. If you add content on this page, remove the redirect rule 'install -> install/install'
.. toctree::
install/install

View File

@ -299,7 +299,7 @@ in ``/etc/nginx/sites-enabled/odoo.conf`` set:
}
server {
listen 443;
listen 443 ssl;
server_name odoo.mycompany.com;
proxy_read_timeout 720s;
proxy_connect_timeout 720s;
@ -312,7 +312,6 @@ in ``/etc/nginx/sites-enabled/odoo.conf`` set:
proxy_set_header X-Real-IP $remote_addr;
# SSL parameters
ssl on;
ssl_certificate /etc/ssl/nginx/server.crt;
ssl_certificate_key /etc/ssl/nginx/server.key;
ssl_session_timeout 30m;

View File

@ -44,4 +44,4 @@ For Exim
.. tip::
If you don't have access/manage your email server, use :ref:`inbound messages
<discuss/email_servers/inbound_messages>`.
<email_communication/inbound_messages>`.

View File

@ -107,7 +107,7 @@ Linux
Debian/Ubuntu
'''''''''''''
Odoo 13.0 'deb' package currently supports `Debian Buster`_, `Ubuntu 18.04`_ or above.
Odoo 15.0 'deb' package currently supports `Debian 11 (Bullseye)`_, `Ubuntu 20.04 (Focal)`_ or above.
Prepare
^^^^^^^
@ -134,7 +134,7 @@ used to install *Odoo Community Edition* by executing the following commands **a
.. code-block:: console
# wget -O - https://nightly.odoo.com/odoo.key | apt-key add -
# echo "deb http://nightly.odoo.com/13.0/nightly/deb/ ./" >> /etc/apt/sources.list.d/odoo.list
# echo "deb http://nightly.odoo.com/15.0/nightly/deb/ ./" >> /etc/apt/sources.list.d/odoo.list
# apt-get update && apt-get install odoo
You can then use the usual `apt-get upgrade` command to keep your installation up-to-date.
@ -180,7 +180,7 @@ and automatically start the server.
Fedora
''''''
Odoo 13.0 'rpm' package supports Fedora 30.
Odoo 15.0 'rpm' package supports Fedora 34.
Prepare
^^^^^^^
@ -209,7 +209,7 @@ commands:
.. code-block:: console
$ sudo dnf config-manager --add-repo=https://nightly.odoo.com/13.0/nightly/rpm/odoo.repo
$ sudo dnf config-manager --add-repo=https://nightly.odoo.com/15.0/nightly/rpm/odoo.repo
$ sudo dnf install -y odoo
$ sudo systemctl enable odoo
$ sudo systemctl start odoo
@ -224,7 +224,7 @@ Once downloaded, the package can be installed using the 'dnf' package manager:
.. code-block:: console
$ sudo dnf localinstall odoo_13.0.latest.noarch.rpm
$ sudo dnf localinstall odoo_15.0.latest.noarch.rpm
$ sudo systemctl enable odoo
$ sudo systemctl start odoo
@ -302,13 +302,13 @@ Prepare
Python
^^^^^^
Odoo requires Python 3.6 or later to run. Visit `Python's download page <https://www.python.org/downloads/windows/>`_
Odoo requires Python 3.7 or later to run. Visit `Python's download page <https://www.python.org/downloads/windows/>`_
to download and install the latest version of Python 3 on your machine.
During installation, check **Add Python 3 to PATH**, then click **Customize Installation** and make
sure that **pip** is checked.
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
.. note:: If Python 3 is already installed, make sure that the version is 3.7 or above, as previous
versions are not compatible with Odoo.
.. code-block:: doscon
@ -466,10 +466,10 @@ Prepare
Python
^^^^^^
Odoo requires Python 3.6 or later to run. Use your package manager to download and install Python 3
Odoo requires Python 3.7 or later to run. Use your package manager to download and install Python 3
on your machine if it is not already done.
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
.. note:: If Python 3 is already installed, make sure that the version is 3.7 or above, as previous
versions are not compatible with Odoo.
.. code-block:: console
@ -635,10 +635,10 @@ Prepare
Python
^^^^^^
Odoo requires Python 3.6 or later to run. Use your preferred package manager (homebrew_, macports_)
Odoo requires Python 3.7 or later to run. Use your preferred package manager (homebrew_, macports_)
to download and install Python 3 on your machine if it is not already done.
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
.. note:: If Python 3 is already installed, make sure that the version is 3.7 or above, as previous
versions are not compatible with Odoo.
.. code-block:: console
@ -752,11 +752,11 @@ Docker
The full documentation on how to use Odoo with Docker can be found on the
official Odoo `docker image <https://registry.hub.docker.com/_/odoo/>`_ page.
.. _Debian Buster: https://www.debian.org/releases/buster/
.. _Debian 11 (Bullseye): https://www.debian.org/releases/bullseye/
.. _demo: https://demo.odoo.com
.. _docker: https://www.docker.com
.. _download: https://www.odoo.com/page/download
.. _Ubuntu 18.04: http://releases.ubuntu.com/18.04/
.. _Ubuntu 20.04 (Focal): http://releases.ubuntu.com/20.04/
.. _EPEL: https://fedoraproject.org/wiki/EPEL
.. _PostgreSQL: http://www.postgresql.org
.. _the official installer:

View File

@ -6,9 +6,10 @@ Maintain
.. toctree::
maintain/domain_names
maintain/update
maintain/db_upgrade
maintain/enterprise
maintain/hosting_changes
maintain/db_premise
maintain/online
maintain/on_premise
maintain/supported_versions

View File

@ -1,413 +0,0 @@
.. |assistance-contact| replace::
If you need Odoo assistance on this matter, please contact your Odoo Account Manager or contact
our `Sales department`_.
.. _Sales department: mailto:sales@odoo.com
.. _db-upgrade:
================
Versions upgrade
================
.. _db-upgrade/overview:
Overview
========
.. _db-upgrade/process:
The upgrade process
-------------------
This documentation is for our *On-Premise* (self-hosted) and *Odoo.sh* customers.
.. _db-upgrade/definition:
Definition
~~~~~~~~~~
An upgrade is switching to a newer version of Odoo (e.g., Odoo 13.0 to Odoo 14.0)
An upgrade does not cover:
* changing :ref:`Editions <db-upgrade/faq/editions-change>` (i.e., Community to Enterprise edition)
* switching :ref:`hosting type <db-upgrade/faq/hosting-types-switch>` (i.e., On-Premise to Online or
Odoo.sh)
* migration from another ERP to Odoo
.. note:: |assistance-contact|
.. _db-upgrade/process-workflow:
Process workflow
~~~~~~~~~~~~~~~~
The upgrade process in a nutshell:
#. You create a test upgrade request.
#. | The request is processed by Odoo:
| This happens via an automated process that runs the database through an upgrade script and
takes between 20 and 120 minutes. Only if an issue(s) arises will we have to intervene
manually and adjust the script specifically to your database until the upgrade succeeds.
#. Odoo delivers a test database.
#. You test your database for possible discrepancies (see :ref:`db-upgrade/test-guidance`)
#. If there are any discrepancies, you report them to the Upgrade support team via the
:ref:`Help portal <db-upgrade/test-assistance>`.
#. We will fix the issues and send you a new test database.
#. Once you completed the testing and are happy with the result, you decide on a date and time when
you stop users from accessing Odoo, freeze all data entries and create an upgrade request for the
production upgrade.
#. Odoo delivers the production database through the automated process.
#. You restore it in your Production environment a few short hours later and continue working on the
newly upgraded database.
.. _db-upgrade/service-level:
Service Level Agreement
-----------------------
What is covered by the Enterprise Licence?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Databases hosted on Odoos Cloud platforms (Saas and Odoo.sh) or On-Premise (Self-Hosting) enjoy the
following service at all times.
The upgrade of:
* standard applications
* Studio customization (as long as the Studio app is still active)
* customizations done by our consulting and developer services *if* they are covered by a
Maintenance of Customisations subscription
The Upgrade Service is limited to the technical conversion and adaptation of your database (standard
modules and data) to make it compatible with the targeted version.
What upgrading does NOT cover
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* The cleaning of pre-existing data & configuration while upgrading
* Any new developments and/or upgrade of your own :ref:`custom modules
<db-upgrade/faq/custom-modules>`
* `Training <https://www.odoo.com/learn>`_ on the new version
You can get more information about your Enterprise Licence on our :ref:`Odoo Enterprise Subscription
Agreement <upgrade>` page.
.. note:: |assistance-contact|
.. _db-upgrade/get-started:
Get started
===========
The upgrade process varies depending on where your database is hosted.
.. _db-upgrade/online:
Online (SaaS)
-------------
If you are hosted Online, please check your `database manager <https://www.odoo.com/my/databases>`_.
.. _db-upgrade/odoo-sh:
Odoo.sh
-------
If you are Odoo.sh hosted, check our :doc:`specific instructions to be able to upgrade
<../odoo_sh/advanced/upgrade_your_database>`.
.. _db-upgrade/on-premise:
On-Premise
----------
There are two possibilities:
#. Via the interface of our `website form <https://upgrade.odoo.com>`_
#. | For technically-advanced users and partners, via the following command line (to be used on the
machine where your database is hosted):
| ``python <(curl -s beta.upgrade.odoo.com/upgrade) test -d <your db name> -t 14.0``
What does it do?
~~~~~~~~~~~~~~~~
The above command will dump your database to a file, then send it to the upgrade platform for
upgrade, displaying you the live logs, then restore the upgraded database back on your server as a
duplicate test database.
.. _db-upgrade/steps:
Steps
=====
.. _db-upgrade/steps-test:
The testing phase
-----------------
.. _db-upgrade/test-process:
Test process
~~~~~~~~~~~~
Also referred to as the pre-production phase, the test phase allows you to review an upgraded
version of your database without affecting your production database in any way.
We suggest that you run the test upgrade process at least once, but you can do it as often as you
want (one at a time).
Once you receive your upgraded test database, you should check that all data, processes and
functionality are still correct and working as expected.
If you do find discrepancies, you'll be able to:
* | :ref:`Report your issues <db-upgrade/test-assistance>`
| and/or
* Ask for a new :ref:`test request <db-upgrade/test-db-request>` after the reported issues have
been fixed in the upgrade script.
When you do not find any discrepancies, you'll be able to:
* Move on to the upgrade of your :ref:`production database <db-upgrade/production-live>`.
.. _db-upgrade/test-db-request:
Request a test database
~~~~~~~~~~~~~~~~~~~~~~~
When filling the `website form <https://upgrade.odoo.com>`_, select *Testing* purpose.
.. image:: media/db-upgrade-test-purpose.png
:align: center
:alt: Selection of the "Testing" purpose in the upgrade form on Odoo
.. _db-upgrade/test-guidance:
Test guidance
~~~~~~~~~~~~~
Every business and organization has its own operational needs and will have to test its specific
Odoo instance respectively. However, we recommend you look at `the test scenario
<https://drive.google.com/open?id=1Lm4JqbsHBirB1wMi14UChoz_YHLjx5ec>`_ we created, a high-level idea
of what you should test and look out for.
.. todo:: change link "test scenario" once the related doc is published
.. _db-upgrade/test-assistance:
Assistance
~~~~~~~~~~
If you encounter issues or problems in the **test database**, please contact the Odoo Upgrade
Support:
#. Connect to our `Odoo Support page <https://www.odoo.com/help>`_.
#. Under the *Ticket Description* section, select *An issue related to my upgrade* ticket type.
.. image:: media/db-upgrade-test-assistance.png
:align: center
:alt: Selection of "An issue related to my upgrade" as Ticket Type in the support form on Odoo
.. warning::
If you choose another *Ticket Description* type, the request will be redirected to another
team than the upgrade one and will slow down the processing and response time.
#. Please provide as much detail as you can. Where applicable, illustrate the current and previous
flows with videos and/or screenshots. This will avoid clarifying questions and speed up the
resolution process significantly.
.. image:: media/db-upgrade-test-assistance-details.png
:align: center
:alt: "Detailed Description" field in the support form on Odoo
.. note::
* The purpose of the test phase is not to correct existing data or configurations in your
database.
* |assistance-contact|
.. _db-upgrade/steps-production:
The production launch
---------------------
.. _db-upgrade/production-live:
Production goes live
~~~~~~~~~~~~~~~~~~~~
The production upgrade request is when you decide to upgrade your current database with all your
production data (invoices, VAT returns, inventories, current orders) to a new version of your choice.
After your :ref:`tests <db-upgrade/steps-test>` are completed to your satisfaction, submit the
request to upgrade your production database via our `website form <https://upgrade.odoo.com>`_.
Select *Production* purpose.
.. image:: media/db-upgrade-production-purpose.png
:align: center
:alt: Selection of the "Production" purpose in the upgrade form on Odoo
.. danger::
Going into production without first testing may lead to:
- business interruptions (e.g. no longer having the possibility to validate an action)
- poor customer experiences (e.g. an eCommerce website that does not work correctly)
.. _db-upgrade/production-assistance:
Assistance
~~~~~~~~~~
If you encounter issues or problems in the **production database**, please contact the **Odoo
Support**:
#. Connect to our `Odoo Support page <https://www.odoo.com/help>`_.
#. Under the *Ticket Description* section, select the appropriate type related to your issue but
**do not select** the option *An issue related to my upgrade*.
.. note::
After upgrading to production, the support will be provided by the Support team instead of the
Upgrade team.
#. Please provide as much detail as you can. Where applicable, illustrate the current and previous
flows with videos and/or screenshots. This will avoid clarifying questions and speed up the
resolution process significantly.
.. image:: media/db-upgrade-production-assistance-details.png
:align: center
:alt: "Detailed Description" field in the support form on Odoo
.. warning::
If you choose *An issue related to my upgrade* as ticket type, the request will be redirected
to another team than the support one and will slow down the processing and response time.
.. _db-upgrade/faq:
FAQ
===
.. _db-upgrade/faq/why:
Why upgrade?
------------
* You benefit from the latest features of the :ref:`new major version
<db-upgrade/faq/release-notes>` released by Odoo.
* If you are in an :ref:`unsupported version <db-upgrade/supported-versions>`, you get a new version
with support.
.. _db-upgrade/faq/when:
When to upgrade?
----------------
Whenever you want. You can make your upgrade request as soon as a new version is released on our
`website form <https://upgrade.odoo.com>`_.
.. _db-upgrade/faq/availability:
Availability of the new version
-------------------------------
Please kindly note that as soon as we announce the release of a new major version (usually at the
end of year), the Upgrade Service team needs to adapt the upgrade scripts to it, which is why the
new version is not immediately available for existing databases.
.. _db-upgrade/faq/finalization:
Finalization of the upgrade (:abbr:`ETA (Estimated Time of Arrival)`)
---------------------------------------------------------------------
Unfortunately, it is impossible to give time estimates for every upgrade request. Odoo offers so
many possibilities (e.g. branding, workflows, customization, etc) that it can get tricky to upgrade,
and translate to the new structure. If you use multiple apps managing sensitive data (e.g.,
Accounting, Inventory, etc.), some cases may still require a human intervention, making the process
slower.
This is especially true during the first months following the release of a new major version, which
can significantly lengthen the upgrade delay.
In general, the smaller the database, the quickest the upgrade. A single-user database that uses
only CRM will be processed faster than a multi-company, multi-user database that uses Accounting,
Sales, Purchase, and Manufacturing.
So, in a nutshell, what can impact your upgrade lead time?
* Source & targeted versions
* Installed apps
* Volume of data
* Amount of customization (models, fields, methods, workflows, reports, website, etc.)
* Installation of new apps or configuration changes after the start of the test phase
Usually, the delays experienced during the first request (waiting time between the time you
submitted your first request for a test upgrade) can generally give you an idea of the time to wait
for the production request.
.. _db-upgrade/faq/custom-modules:
Upgrade of the custom modules
-----------------------------
As stated in our :doc:`/legal/terms/enterprise`, section :ref:`charges_standard`, this optional
service is subject to additional fees.
If you have a custom code, you can choose to have it upgraded by our services, by one of our
`partners <https://www.odoo.com/partners>`_ or you can do it yourself.
.. note:: |assistance-contact|
.. _db-upgrade/faq/editions-change:
Editions change (from Community to Enterprise)
----------------------------------------------
An upgrade does not cover a change of `Editions <https://www.odoo.com/page/editions>`_
.. note:: |assistance-contact|
.. _db-upgrade/faq/hosting-types-switch:
Switching the hosting types (Self-hosted vs Online vs Odoo.sh)
--------------------------------------------------------------
An upgrade does not cover a change of `Hosting types <https://www.odoo.com/page/hosting-types>`_.
Open the following link to get :doc:`more information about how to change your hosting type
<hosting_changes>`.
.. note:: |assistance-contact|
.. _db-upgrade/faq/release-notes:
Release Notes by version
------------------------
Open our `Release Note <https://www.odoo.com/page/release-notes>`_ page to get a summary of the new
features and improvements made in each version.
.. _db-upgrade/assistance:
Assistance
==========
.. _db-upgrade/contact:
Contact our Upgrade service support
-----------------------------------
Should you have any more questions about the upgrade, do not hesitate to send a message to `Odoo
Upgrade Team <mailto:upgrade@odoo.com>`_. We will be very pleased to answer it as soon as possible.
.. _db-upgrade/supported-versions:
Supported versions
------------------
Please note that Odoo provides support and bug fixing only for the three last major versions of Odoo.
This is a factor to take into consideration before upgrading. If you are on an older version, we
suggest you to prefer the most recent version to benefit from a longer support (before having to
upgrade again).
You can get more information about our :doc:`supported versions <supported_versions>`.

View File

@ -0,0 +1,326 @@
============
Domain names
============
A **domain name** works as an address for your website. It makes the Internet much more accessible
as it allows users to type a meaningful web address, such as ``www.odoo.com``, rather than its
server's IP address with a series of numbers.
You can use a custom domain name to access your Odoo database and websites:
- By :ref:`registering a free domain name with Odoo <domain-name/odoo-register>` (for Odoo Online
databases)
- By :ref:`configuring a custom domain that you already own <domain-name/existing>`.
.. note::
Odoo Online and Odoo.sh databases, including their websites, use by default a subdomain of
``odoo.com`` for both the URL and the emails (e.g., ``https://example.odoo.com``).
.. important::
Odoo offers a :ref:`free custom domain name <domain-name/odoo-register>` to all Odoo Online
databases for one year. Visitors can then access your website with an address such as
``www.example.com`` rather than the default ``example.odoo.com``.
.. _domain-name/about:
About domain names
==================
Having a **good domain name** is as important to your branding as the name of your business or
organization as it is the first thing your visitors will notice. We recommend you keep them *simple,
short, easy to remember and spell*.
A **subdomain** is a domain that is a part of another domain. It often refers to the additional part
that comes before the main domain name. Traditionally, most websites use the ``www.`` subdomain,
but any string of letters can be used as well. You can use subdomains to direct your visitors to
other websites than your main website or to specific pages (e.g., ``experience.odoo.com`` points to
a specific page.)
All domain names are referenced in the **Domain Name System**, or **DNS**, which works as a giant
directory for the Internet. There are many DNS servers, so any modification to the DNS can take up
to 72 hours to propagate worldwide on all servers.
.. _domain-name/odoo-register:
Register a free domain name with Odoo
=====================================
You can register a domain name for your Odoo Online database directly from Odoo Website or your
database manager.
.. important::
- Your domain name is **free for one year** if you register it with Odoo!
- The domain name is registered with `Gandi <https://www.gandi.net/>`_, the domain name
registrar.
- You are the owner of the domain name and can use it for other purposes.
- Odoo manages payment and technical support for you.
To do so, go to :menuselection:`Website --> Go to website --> Promote --> Domain Name`.
Alternatively, open your `database manager <https://www.odoo.com/my/databases>`_, click on the
*settings* button next to your database, then on *Domain names*.
.. image:: domain_names/register-promote.png
:align: center
:alt: Clicking on Domain Names from an Odoo website
Search for the domain name of your choice to check its availability, then select the one you want to
register for your website.
.. image:: domain_names/register-search.png
:align: center
:alt: The search of the domain name example.com shows which associated domains are available.
Next, fill in the form with your information to become the domain name owner.
Your domain name is directly linked to your database, but you still have to :ref:`map your domain
name with your website <domain-name/website-map>`.
.. note::
- Free domain names are also available for free Odoo Online databases (if you installed one app
only, for example). In this case, Odoo reviews your request and your website to avoid abuse.
This process may take up to three days.
- This is not available for Odoo.sh databases yet.
.. _domain-name/odoo-manage:
Manage your domain name registered with Odoo
--------------------------------------------
To manage the DNS records of your domain name registered with Odoo or to visualize the contacts
associated with it, open your `database manager <https://www.odoo.com/my/databases>`_, click on the
*settings* button next to your database, on *Domain names*, and then on *Contacts* or *DNS*.
.. image:: domain_names/manage.png
:align: center
:alt: Management of the domain names linked to an Odoo database
.. note::
Please `submit a support ticket <https://www.odoo.com/help>`_ if you need further assistance to
manage your domain name.
.. _domain-name/existing:
Configure your existing domain name
===================================
If you already own a domain name, you can use it to point to your website.
To avoid any issue with the :ref:`SSL certificate validation <domain-name/ssl>`, we highly recommend
that you proceed with the following actions in this order:
#. :ref:`Add a CNAME record <domain-name/cname>` on your domain name's DNS zone.
#. :ref:`Map your domain name with your Odoo database <domain-name/db-map>`.
#. :ref:`Map your domain name with your Odoo website <domain-name/website-map>`.
.. _domain-name/cname:
Add a CNAME record
------------------
A **CNAME record** is a type of DNS record that points to the IP address of another website rather
than to directly to an IP address.
You need a CNAME record that points to your Odoo database. The requirements are detailed in your
database manager.
.. tabs::
.. group-tab:: Odoo Online
The target address is the current address of your database, as defined at its creation (e.g.,
``example.odoo.com``)
.. group-tab:: Odoo.sh
Your project's main address is defined in :menuselection:`Settings --> Project Name`.
If you want to target a specific branch (production, staging or development), go to
:menuselection:`Branches --> select your branch --> Settings --> Custom domains`, and click on
*How to set up my domain?*. A message indicates which address your CNAME record should target.
#. Open your domain name's manager dashboard.
#. Open the **DNS zone** management page for the domain name you want to configure.
#. Create a **CNAME record** pointing to the address of your database.
While Odoo suggests creating a CNAME record for your ``www.`` subdomain (``www.example.com``, you
can of course use any domain name of your choice, with any subdomain (e.g.,
``anything.example.com``).
.. example::
You own the domain name ``example.com``, and you have an Odoo Online database at the address
``example.odoo.com``. You want to access your Odoo database primarily with the domain
``www.example.com`` but also with the :ref:`naked domain <domain-name/naked-domain>`
``example.com``.
To do so, you create a CNAME record for the ``www`` subdomain, with ``example.odoo.com`` as the
target. The DNS zone manager generates the following rule and adds it to your DNS zone: ``www IN
CNAME example.odoo.com.``
You also create a redirection from ``example.com`` to ``wwww.example.com``.
Your new DNS records are propagated to all DNS servers.
.. note::
Here are some specific guidelines to create a CNAME record:
- `GoDaddy <https://www.godaddy.com/help/add-a-cname-record-19236>`_
- `Namecheap <https://www.namecheap.com/support/knowledgebase/article.aspx/9646/2237/how-to-create-a-cname-record-for-your-domain>`_
- `OVH <https://docs.ovh.com/us/en/domains/web_hosting_how_to_edit_my_dns_zone/#add-a-new-dns-record>`_
- `CloudFlare <https://support.cloudflare.com/hc/en-us/articles/360019093151>`_
- `Google Domains <https://support.google.com/domains/answer/3290350?hl=en>`_
.. _domain-name/naked-domain:
Naked domain
~~~~~~~~~~~~
A **naked domain** is a domain name that doesn't have any subdomain at the beginning of the address
(e.g., ``odoo.com`` instead of ``www.odoo.com``).
You may want your naked domain to redirect to your website as some visitors may not type the full
domain name to access your website.
#. Open your domain name's manager dashboard.
#. Create a **redirection** from the naked domain (``example.com``) to your main domain name
(``www.example.com``)
.. note::
Depending on your domain name registrar, this redirection may be already pre-configured.
.. _domain-name/db-map:
Map your domain name with your Odoo database
--------------------------------------------
.. tabs::
.. group-tab:: Odoo Online
Open your `database manager <https://www.odoo.com/my/databases>`_, click on the *settings*
button next to your database, on *Domain names*, and then on *Use my own domain* at the bottom
of the right column.
Type the domain name you want to add to this database, then click on *Verify* to check if the
the CNAME record is correctly configured. Once done, click on *I confirm, it's done*.
.. image:: domain_names/online-map.png
:align: center
:alt: Verification of the CNAME records of a domain name before mapping it with a database
.. group-tab:: Odoo.sh
Go to :menuselection:`Branches --> select your branch --> Settings --> Custom domains`, type
the domain name you want to add to this database, then click on *Add domain*.
.. image:: domain_names/odoo-sh-map.png
:align: center
:alt: Mapping a domain name with an Odoo.sh branch
.. seealso::
- :ref:`Odoo.sh branches: settings tab <odoosh-gettingstarted-branches-tabs-settings>`
.. warning::
Make sure to :ref:`add a CNAME record <domain-name/cname>` to your domain name's DNS **before**
mapping your domain name with your Odoo database.
Failing to do so may impede the validation of the :ref:`SSL certificate <domain-name/ssl>` and
would result in a *certificate name mismatch* error. This is often displayed by web browsers as a
warning such as *"Your connection is not private"*.
If this is the case and you have added the domain name to your database's settings less than five
days ago, wait 24 hours as the validation may still happen. Otherwise, please `submit a support
ticket <https://www.odoo.com/help>`_ including screenshots of your CNAME records.
.. _domain-name/ssl:
SSL encryption (HTTPS protocol)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**SSL encryption** is an encryption-based Internet security protocol. It allows your visitors to
navigate your website through a secure connection, which appears as an ``https://`` protocol at the
beginning of your web address, rather than a non-secure ``http://`` protocol.
Odoo generates a separate SSL certificate for each domain :ref:`mapped in the database manager
<domain-name/db-map>`, using integration with `Let's Encrypt Certificate Authority and ACME protocol
<https://letsencrypt.org/how-it-works/>`_.
.. note::
- The certificate generation may take up to 24h.
- Several attempts to validate your certificate are made during the five days following the
moment you add your domain name in your database's settings.
- If you already use another service, you can keep using it or simply change for Odoo.
.. _domain-name/web-base-url:
Web base URL of a database
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. note::
If you have Odoo Website, you can disregard this part and directly :ref:`map your domain name
with your website <domain-name/website-map>`.
The **web base URL** of a database, or **root URL** affects your main website address and all the
links sent to your customers (e.g., quotations, portal links, etc.).
To configure it, access your Odoo database with your custom address, then log in as an administrator
of your database (any user in the *Settings* group) from the login screen.
.. warning::
Connecting to your database with the original Odoo subdomain address (e.g., ``example.odoo.com``
also updates the web base URL of your database. See below to prevent these automatic updates.
Alternatively, you can do it manually. To do so, activate the :ref:`developer mode
<developer-mode>`, then go to :menuselection:`Settings --> Technical --> System Parameters`.
Find the key called ``web.base.url`` (or create it if it does not exist) and enter the full address
of your website as value, such as ``https://www.example.com``.
.. note::
The URL must include the protocol ``https://`` (or ``http://``) and must not end with a slash
(``/``).
To prevent the automatic update of the web base URL when an administrator logs in the database, you
can create the following System Parameter:
- key: ``web.base.url.freeze``
- value: ``True``
.. _domain-name/website-map:
Map your domain name with your website
======================================
Mapping your domain name to your website isn't the same as mapping it with your database:
- It defines your domain name as the main one for your website, helping search engines to index your
website properly.
- It defines your domain name as the base URL for your database, including the portal links sent by
email to your customers.
- If you have multiple websites, it maps your domain name with the appropriate website.
Go to :menuselection:`Website --> Configuration --> Settings --> Website Info`. If you have multiple
websites, select the one you want to configure.
In the **Domain** field, fill in the web address of your website (e.g., ``https://www.example.com``)
and click on *Save*.
.. image:: domain_names/website-settings.png
:align: center
:alt: Configuring https://www.example.com as the Domain of the website
.. warning::
Mapping your domain name with your Odoo website prevents Google from indexing both your custom
domain name ``www.example.com`` and your original odoo database address ``example.odoo.com``.
If both addresses are already indexed, it may take some time before Google removes the indexation
of the second address. You may also try using the `Google Search Console
<https://search.google.com/search-console/welcome>`_ to fix this.
.. note::
If you have multiple websites and companies on your database, make sure that you select the
right **Company** in the website settings, next to the **Domain** settings. Doing so indicates
Odoo which URL to use as the :ref:`base URL <domain-name/web-base-url>` according to the company
in use.
.. seealso::
- :doc:`/applications/general/email_communication/email_servers`

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.2 KiB

View File

@ -49,7 +49,7 @@ From Odoo.sh to Odoo Online
1. Uninstall all the **non-standard apps**: test it in a staging build first, then do it in your production build.
2. **If you have time constraints, contact us earlier to schedule the transfer.**
3. `Create a support ticket <https://www.odoo.com/help>`_ and attach the dump (if the file is too large, use any file transfer service and attach the link to your ticket). Also include your subscription number and the URL you want to use for your database (e.g.: my-company.odoo.com).
3. `Create a support ticket <https://www.odoo.com/help>`_ and include your subscription number and the URL you want to use for your database (e.g.: my-company.odoo.com).
4. We will make sure your database is compatible and upload it to our cloud. In case of technical issues, we will get in touch with you.
5. It's done!

View File

@ -1,9 +1,6 @@
.. _db_premise:
===============================
On-premises Database management
===============================
==============================
On-premise database management
==============================
Register a database
===================
@ -12,7 +9,7 @@ To register your database, you just need to enter your Subscription Code in the
banner in the App Switcher. Make sure you do not add extra spaces before or after
your subscription code. If the registration is successful, it will turn green and
will provide you with the Expiration Date of your freshly-registered database. You
can check this Epiration Date in the About menu (Odoo 9) or in the Settings Dashboard
can check this Expiration Date in the About menu (Odoo 9) or in the Settings Dashboard
(Odoo 10).
Registration Error Message
@ -21,7 +18,7 @@ Registration Error Message
If you are unable to register your database, you will likely encounter this
message:
.. image:: media/error_message_sub_code.png
.. image:: on_premise/error_message_sub_code.png
:align: center
:alt: Something went wrong while registering your database,
you can try again or contact Odoo Help
@ -44,14 +41,14 @@ Solutions
* You can unlink the old database yourself on your `Odoo Contract
<https://accounts.odoo.com/my/subscription>`__ with the button "Unlink database"
.. image:: media/unlink_single_db.png
.. image:: on_premise/unlink_single_db.png
:align: center
A confirmation message will appear; make sure this is the correct database as
it will be deactivated shortly:
.. image:: media/unlink_confirm_enterprise_edition.png
.. image:: on_premise/unlink_confirm_enterprise_edition.png
:align: center
@ -65,7 +62,7 @@ Solutions
<https://accounts.odoo.com/my/subscription>`__, a short message will appear
specifying which database is problematic:
.. image:: media/unlink_db_name_collision.png
.. image:: on_premise/unlink_db_name_collision.png
:align: center
@ -96,7 +93,7 @@ Error message due to too many users
If you have more users in your local database than provisionned in your
Odoo Enterprise subscription, you may encounter this message:
.. image:: media/add_more_users.png
.. image:: on_premise/add_more_users.png
:align: center
:alt: This database will expire in X days, you
have more users than your subscription allows
@ -125,7 +122,7 @@ Database expired error message
If your database reaches its expiration date before your renew your subscription,
you will encounter this message:
.. image:: media/database_expired.png
.. image:: on_premise/database_expired.png
:align: center
:alt: This database has expired.
@ -157,7 +154,7 @@ You can duplicate your database by accessing the database manager on your
server (<odoo-server>/web/database/manager). In this page, you can easily
duplicate your database (among other things).
.. image:: media/db_manager.gif
.. image:: on_premise/db_manager.gif
:align: center
@ -175,5 +172,5 @@ System Parameters`, we advise you to use a `uuid generator <https://www.uuidtool
use the unix command ``uuidgen`` to generate a new uuid. You can then simply replace it like any
other record by clicking on it and using the edit button.
.. image:: media/db_uuid.png
.. image:: on_premise/db_uuid.png
:align: center

View File

Before

Width:  |  Height:  |  Size: 9.5 KiB

After

Width:  |  Height:  |  Size: 9.5 KiB

View File

Before

Width:  |  Height:  |  Size: 4.6 KiB

After

Width:  |  Height:  |  Size: 4.6 KiB

View File

Before

Width:  |  Height:  |  Size: 89 KiB

After

Width:  |  Height:  |  Size: 89 KiB

View File

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 17 KiB

View File

Before

Width:  |  Height:  |  Size: 6.9 KiB

After

Width:  |  Height:  |  Size: 6.9 KiB

View File

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

View File

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

View File

@ -0,0 +1,155 @@
=================================
Online (SaaS) database management
=================================
To manage a database, sign in to https://www.odoo.com and access the `database management page
<https://www.odoo.com/my/databases>`_ by clicking on the user icon, then on *My Databases*.
.. image:: online/my-databases.png
:align: center
:alt: Clicking on the user icon opens a drop-down menu. "My databases" button is highlighted.
.. note::
Make sure you are connected as the administrator of the database you want to manage.
.. image:: online/dropdown-menu.png
:align: right
:alt: Clicking on the gear icon opens the drop-down menu.
Open the drop-down menu next to the database you want to manage by clicking on the gear icon.
Several actions are available:
- :ref:`online/upgrade`
- :ref:`online/duplicate`
- :ref:`online/rename`
- :ref:`online/download`
- :ref:`online/domains`
- :ref:`online/tags`
- :ref:`online/delete`
- :ref:`online/contact-support`
- :ref:`online/users`
.. _online/upgrade:
Upgrade
=======
If you are *not* on the latest **Online version**, you should receive an invitation to :doc:`upgrade
<../upgrade/process>` your database. A **Rolling Release button** on your database's main screen
proposes an upgrade to the latest version (e.g., 13.0 to 15.1).
.. important::
- | **If your Odoo database's version is lower than the latest major release:**
| You must upgrade your database within two months. After these two months, an automatic
upgrade is initiated.
- | **If your Odoo database's version is equal to or higher than the latest major release:**
| You can disregard the invitation to upgrade as you probably wouldn't benefit from new
features every two months.
.. note::
Versions that are not supported anymore become deprecated and need to be updated to avoid
security issues. We recommend you initiate the upgrade of the database yourself, as this method
allows you to request a test upgrade of your database to check for any discrepancies.
.. seealso::
- :doc:`../upgrade/process`
- :doc:`supported_versions`
.. _online/duplicate:
Duplicate
=========
Make an exact copy of the database to be able to perform testing without compromising the daily
operations.
.. important::
- By checking *For testing purposes*, all external communication (emails, payments, delivery
orders, etc.) are disabled by default on the duplicated database.
- Duplicate databases expire automatically after 15 days.
.. _online/rename:
Rename
======
Rename the database and its URL.
.. _online/download:
Download
========
Download instantly a ZIP file with a backup of the database.
.. note::
Databases are backed up daily according to the `Odoo Cloud SLA
<https://www.odoo.com/cloud-sla>`_.
.. _online/domains:
Domains
=======
Configure custom domains to access the database via another URL.
.. seealso::
- :doc:`domain_names`
.. _online/tags:
Tags
====
Add tags to sort your databases out. You can search the tags in the search bar.
.. _online/delete:
Delete
======
Delete a database instantly.
.. danger::
Deleting a database means that all data is permanently lost. The deletion is instant and for all
users. It is recommended to create a backup of the database before deleting it.
Read carefully the warning message that pops up and proceed only if you fully understand the
implications of deleting a database:
.. image:: online/delete.png
:align: center
:alt: A warning message is prompted before deleting a database.
.. note::
- Only an administrator can delete a database.
- The database name is immediately available for a new database.
- It is not possible to delete a database if it is expired or linked to a subscription. If
needed, please get in touch with `Odoo Support <https://www.odoo.com/help>`_.
- To delete your account, please get in touch with `Odoo Support <https://www.odoo.com/help>`_.
.. _online/contact-support:
Contact Support
===============
Access the Odoo `support page <https://www.odoo.com/help>`_ with your database's details already
pre-filled.
.. _online/users:
Invite / Remove Users
=====================
To invite users, fill out the email address of the new user and click on *Invite*. To add multiple
users, click on *Add more users*.
.. image:: online/invite-users.png
:align: center
:alt: Clicking on "Add more users" adds additional email fields.
To remove users, select the users to remove and click on *Remove*.
.. seealso::
- :doc:`/applications/general/users/manage_users`

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.6 KiB

View File

@ -5,13 +5,16 @@
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.
.. note::
Odoo releases intermediary versions called **Online versions** on the :doc:`Odoo Online <online>`
hosting every two months. Odoo Online users can then benefit from the latest features of Odoo.
- Admins of Odoo Online databases are invited to :doc:`upgrade <../upgrade/process>` them
regularly.
- Online versions are *not* released for Odoo.sh and On-Premise installations.
- Online versions are listed below as *SaaS*.
What's the support status of my Odoo?
=====================================
@ -20,38 +23,39 @@ This matrix shows the support status of every version.
**Major releases are in bold type.**
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| | Odoo Online | Odoo.sh | On-Premise | Release date | |
+====================+=============+==========+==============+================+==============================================+
| **Odoo 14.0** | |green| | |green| | |green| | October 2020 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| Odoo 13.saas~4 | |green| | N/A | N/A | August 2019 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| **Odoo 13.0** | |green| | |green| | |green| | October 2019 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| Odoo 12.saas~3 | |green| | N/A | N/A | August 2019 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| **Odoo 12.0** | |green| | |green| | |green| | October 2018 | *End-of-support is planned for October 2021* |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| Odoo 11.saas~3 | |orange| | N/A | N/A | April 2018 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| **Odoo 11.0** | |orange| | |orange| | |red| | October 2017 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| Odoo 10.saas~15 | |orange| | N/A | N/A | March 2017 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| Odoo 10.saas~14 | |orange| | N/A | N/A | January 2017 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| **Odoo 10.0** | |orange| | |orange| | |red| | October 2016 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| Odoo 9.saas~11 | |orange| | N/A | N/A | May 2016 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| **Odoo 9.0** | |orange| | N/A | |red| | October 2015 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| Odoo 8.saas~6 | |orange| | N/A | N/A | February 2015 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
| **Odoo 8.0** | |orange| | N/A | |red| | September 2014 | |
+--------------------+-------------+----------+--------------+----------------+----------------------------------------------+
+-----------------+-------------+----------+-------------+----------------+------------------------+
| | Odoo Online | Odoo.sh | On-Premise | Release date | End of support |
+=================+=============+==========+=============+================+========================+
| Odoo 15.saas~1 | |green| | N/A | N/A | February 2022 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 15.0** | |green| | |green| | |green| | October 2021 | October 2024 (planned) |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 14.0** | |green| | |green| | |green| | October 2020 | October 2023 (planned) |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 13.0** | |green| | |green| | |green| | October 2019 | October 2022 (planned) |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo 12.saas~3 | |red| | N/A | N/A | August 2019 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 12.0** | |red| | |red| | |red| | October 2018 | October 2021 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo 11.saas~3 | |red| | N/A | N/A | April 2018 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 11.0** | |red| | |red| | |red| | October 2017 | October 2020 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo 10.saas~15 | |red| | N/A | N/A | March 2017 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo 10.saas~14 | |red| | N/A | N/A | January 2017 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 10.0** | |red| | |red| | |red| | October 2016 | October 2019 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo 9.saas~11 | |red| | N/A | N/A | May 2016 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 9.0** | |red| | N/A | |red| | October 2015 | October 2018 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo 8.saas~6 | |red| | N/A | N/A | February 2015 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 8.0** | |red| | N/A | |red| | September 2014 | October 2017 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
.. note::
@ -61,10 +65,10 @@ This matrix shows the support status of every version.
N/A Never released for this platform
|orange| 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
.. This is an awful way to display colored circles but "Large Green Circle Emoji" was only released
in 2019 (see https://unicode-table.com/en/1F7E2/). Let's wait a few more years...
.. |green| image:: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMzIuMTkgMjMyLjE5Ij48Y2lyY2xlIGN4PSIxMTYuMDkiIGN5PSIxMTYuMDkiIHI9IjExNi4wOSIgc3R5bGU9ImZpbGw6IzAwYTcwMCIvPjwvc3ZnPg==
:width: 15
@ -72,9 +76,6 @@ This matrix shows the support status of every version.
.. |red| image:: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMzIuMTkgMjMyLjE5Ij48Y2lyY2xlIGN4PSIxMTYuMDkiIGN5PSIxMTYuMDkiIHI9IjExNi4wOSIgc3R5bGU9ImZpbGw6I2QwMDAwMCIvPjwvc3ZnPg==
:width: 15
.. |orange| image:: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMzIuMTkgMjMyLjE5Ij48Y2lyY2xlIGN4PSIxMTYuMDkiIGN5PSIxMTYuMDkiIHI9IjExNi4wOSIgc3R5bGU9ImZpbGw6I2ZmYTcwMCIvPjwvc3ZnPg==
:width: 15
I run an older version of Odoo/OpenERP/TinyERP
==============================================

View File

@ -9,5 +9,4 @@ Advanced
advanced/containers
advanced/submodules
advanced/upgrade_your_database
advanced/frequent_technical_questions

View File

@ -213,6 +213,8 @@ This link contains various monitoring metrics of the current build.
You can zoom, change the time range or select a specific metric on each graph.
On the graphs, annotations help you relate to changes on the build (database import, git push, etc...).
.. _odoosh/logs:
Logs
----
A viewer to have a look to your server logs.
@ -382,7 +384,9 @@ we are considering the feature if there is enough demand.
In case the domain of your users email addresses use SPF (Sender Policy Framework) or DKIM
(DomainKeys Identified Mail), don't forget to authorize Odoo as a sending host in your domain name
settings to increase the deliverability of your outgoing emails.
The configuration steps are explained in the :ref:`Discuss app documentation <discuss-email_servers-spf-compliant>`.
The configuration steps are explained in the documentation about :ref:`SPF
<email_communication/spf_compliant>` and :ref:`DKIM <email_communication/dkim_compliant>`.
.. Warning::
Forgetting to configure your SPF or DKIM to authorize Odoo as a sending host can lead to the

View File

@ -184,4 +184,4 @@ as you can only have one database linked per subscription.
If you plan to make it your production,
unlink your former database from the subscription, and register the newly imported database.
Read the :ref:`database registration documentation <db_premise>` for instructions.
Read the :doc:`database registration documentation <../../maintain/on_premise>` for instructions.

View File

@ -0,0 +1,12 @@
:nosearch:
=======
Upgrade
=======
.. toctree::
upgrade/process
upgrade/odoo_sh
upgrade/service_level
upgrade/faq

View File

@ -0,0 +1,171 @@
.. |assistance-contact| replace::
If you need Odoo assistance on this matter, please get in touch with your Odoo Account Manager or
our `Sales department`_.
.. _Sales department: mailto:sales@odoo.com
===
FAQ
===
.. _upgrade-faq/why:
Why upgrade
===========
* You benefit from the latest features of the :ref:`new major version
<upgrade-faq/release-notes>` released by Odoo.
* If you are in an :ref:`unsupported version <upgrade/supported-versions>`, you get a new version
with support.
.. _upgrade-faq/when:
When to upgrade
===============
Whenever you want. You can make your upgrade request as soon as a new version is released or when
your version turns unsupported, and you still wish to enjoy support.
.. _upgrade-faq/availability:
Availability of the new version
===============================
As soon as Odoo announces the release of a new major version, you can create a test upgrade request
to try the latest version. Please note that at this point, the upgrade scripts will only have been
tested with demo data. Please report any issue you might encounter while testing via the `Odoo
Support page <https://www.odoo.com/help>`_ and make sure to be happy with your test version before
requesting the upgrade of your database in production.
.. _upgrade-faq/duration:
Duration of the upgrade
=======================
It is impossible to give time estimates for every upgrade request.
In general, the "smaller" the database, the quickest the upgrade request is completed. A single-user
database that uses only CRM will be processed faster than a multi-company, multi-user database that
uses Accounting, Sales, Purchase, and Manufacturing.
You can expect the time it takes for the platform to upgrade the test database will be similar to
the production upgrade.
.. _upgrade-faq/project:
The upgrade project
===================
It depends on the user involvement (the time spent on testing, reporting problems, etc.) and the
issues encountered that might need to be addressed by our technical team.
So, in a nutshell, what can impact your upgrade lead time?
* Source & targeted versions
* Installed apps
* Volume of data
* Amount of customization (models, fields, methods, workflows, reports, website, etc.)
* Installation of new apps or configuration changes after the start of the test phase
* User commitment
.. _upgrade-faq/custom-modules:
Upgrade of the custom modules
=============================
As stated in our :doc:`/legal/terms/enterprise`, section :ref:`charges_standard`, this optional
service is subject to additional fees.
Depending on your situation, the custom code could be upgraded by our services, by one of our
partners, or you can do it yourself.
.. note:: |assistance-contact|
.. _upgrade-faq/editions-change:
Editions change (from Community to Enterprise)
==============================================
The upgrade always returns an Enterprise edition of Odoo, whether the database you sent was a
community or enterprise edition. It is required to have an enterprise subscription to upgrade.
.. note:: |assistance-contact|
.. seealso::
- `Editions <https://www.odoo.com/page/editions>`_
.. _upgrade-faq/hosting-types-switch:
Switching the hosting types (Self-Hosting vs. Online Hosting - SaaS vs. Cloud Platform - Odoo.sh)
=================================================================================================
An upgrade does not cover a change of `Hosting types <https://www.odoo.com/page/hosting-types>`_.
Open the following link to get :doc:`more information about how to change your hosting type
<../maintain/hosting_changes>`.
.. note:: |assistance-contact|
.. _upgrade-faq/release-notes:
Release Notes by version
========================
Open our `Release Note <https://www.odoo.com/page/release-notes>`_ page to get a summary of the new
features and improvements made in each version.
How long is my test available for
---------------------------------
An Odoo Online (SaaS) test database is available for one month by default. We can extend this trial
period upon request. For Odoo.sh or on-premise, there is no restriction.
How many tests to perform before upgrading to production?
---------------------------------------------------------
As many as needed. When you are comfortable with the database, run a last test upgrade 48 hours
before requesting your production upgrade and test your workflows one last time.
How to/Where to report upgrade issues?
--------------------------------------
If you encounter issues during the upgrade process, please contact the Odoo Support through the
`Odoo Support page <https://www.odoo.com/help>`_
- To report an issue discovered during the testing phase, please select **An issue related to my
upgrade (test phase)**.
- To report an issue discovered post-upgrade, please select **An issue related to my upgrade
(production)**
Upgrading to production
-----------------------
Once you have completed testing and are happy with the result, you decide on a date and time when
you stop users from accessing Odoo, freeze all data entries, and create an upgrade request for the
production upgrade.
How is my data handled in the Upgrade Platform?
-----------------------------------------------
The Odoo Upgrade platform uses the same Privacy Policy as the rest of Odoo.com services.
Your data is hosted on servers that follow our security guidelines, namely:
- SSL - All web connections to client instances are protected with 256-bit SSL encryption
(HTTPS with a 2048-bit modulus SSL certificate), and running behind Grade A SSL stacks. All our
certificate chains are using SHA-2 already.
- Safe System - Our servers are running recent Linux distribution with up-to-date security patches,
with firewall and intrusion countermeasures (not disclosed for obvious reasons).
Servers are located at the same locations as our Cloud providers with the following services:
- Restricted perimeter, physically accessed by authorized data center employees only
- Physical access control with security badges or biometrical security
- Security cameras monitoring the data center locations 24/7
- Security personnel on-site 24/7
The uploaded and migrated databases uploaded to the Upgrade platform are kept for up to 3 months and
are permanently deleted following that period.
You can learn more about privacy and data handling at Odoo by visiting our `General Data Protection
Regulation page <https://www.odoo.com/gdpr>`_.

View File

@ -1,9 +1,7 @@
=====================
Upgrade your database
=====================
.. _odoosh-advanced-upgrade_your_database:
=======================
Odoo.sh version upgrade
=======================
Download and Upload your database
=================================

View File

@ -0,0 +1,256 @@
.. |assistance-contact| replace::
If you need Odoo assistance on this matter, please get in touch with your Odoo Account Manager or
our `Sales department`_.
.. _Sales department: mailto:sales@odoo.com
===============
Upgrade process
===============
.. _upgrade/overview:
Overview
========
An upgrade is switching to a newer version of Odoo (e.g., Odoo 14.0 to Odoo 15.0).
An upgrade does not cover:
* Changing :ref:`editions <upgrade-faq/editions-change>` (i.e., Community to Enterprise edition)
* Switching :ref:`hosting type <upgrade-faq/hosting-types-switch>` (i.e., On-Premise to Online or
Odoo.sh)
* Migration from another ERP to Odoo
.. note:: |assistance-contact|
.. _upgrade/process-workflow:
Process workflow
----------------
The upgrade process in a nutshell:
#. You create a test upgrade request.
#. | Odoo processes the request:
| This happens via an automated process that runs the database through an upgrade script and
takes between 20 and 120 minutes. Only if an issue(s) arises will we have to intervene
manually and adjust the script specifically to your database until the upgrade succeeds.
#. Odoo delivers a test database.
#. You test your database for possible discrepancies (see :ref:`upgrade/test-guidance`)
#. If there are any discrepancies, you report them to the Upgrade support team via the help portal
(see :ref:`upgrade/test-assistance`).
#. We will fix the issues and send you a new test database.
#. Once you have completed the testing and are happy with the result, you decide on a date and time
when you stop users from accessing Odoo, freeze all data entries, and create an upgrade request
for the production upgrade.
#. Odoo delivers the production database through the automated process.
#. You restore it in your Production environment a few short hours later and continue working on the
newly upgraded database (this is done automatically on SaaS).
.. _upgrade/get-started:
Get started
===========
The upgrade process varies depending on where your database is hosted.
.. _upgrade/online:
Online Hosting (SaaS)
---------------------
The upgrade request is made via your `database manager <https://www.odoo.com/my/databases>`_.
.. image:: process/online-access-databases.png
:align: center
:alt: Click on the profile button then on "My Databases"
.. image:: process/online-upgrade-button.png
:align: center
:alt: Click on the settings button next to your database, then on "Upgrade"
.. _upgrade/odoo-sh:
Cloud Platform (Odoo.sh)
------------------------
:doc:`odoo_sh`
.. _upgrade/on-premise:
Self-Hosting (On-Premise)
-------------------------
There are two possibilities:
#. Via `Odoo Upgrade service <https://upgrade.odoo.com>`_
#. | For technically advanced users and partners, via the following command line on the machine
where your database is hosted:
| ``python <(curl -s https://upgrade.odoo.com/upgrade) test -d <your db name> -t <target
version>``
The above command will dump your database to a file, send it to the upgrade platform for an upgrade,
display you the live logs, and restore the upgraded database back on your server as a duplicate test
database.
.. _upgrade/testing-phase:
Testing Phase (pre-production phase)
====================================
This phase allows you to review an upgraded version of your database without affecting your
production database in any way.
We suggest that you run the test upgrade process at least once, but you can do it as many times as
you need (one at a time).
Once you receive your upgraded test database, check that all data, processes, and functionality are
still correct and working as expected.
If you do find discrepancies, report your issues (see :ref:`upgrade/test-assistance`) and request
a new test database (see :ref:`upgrade/test-db-request`) when the reported issues are fixed in
the upgrade script.
If you do not find any discrepancies, you'll be able to move on to the upgrade of your
:ref:`production database <upgrade/production-live>`.
.. _upgrade/test-db-request:
Request a test database
-----------------------
When filling the `website form <https://upgrade.odoo.com>`_, select *Testing* purpose.
.. image:: process/test-purpose.png
:align: center
:alt: Selection of the "Testing" purpose in the upgrade form on Odoo
.. _upgrade/test-guidance:
Test guidance
-------------
Every business and organization has its own operational needs and has to test its specific Odoo
instance respectively. We recommend you look at `the test scenario
<https://docs.google.com/document/d/1ypNs7JKPOsjNbKpdiKFH7Al6g6whZ9jr7f7duAQ5E1w/>` for further
information.
.. todo:: change link "test scenario" once the related doc is published
.. _upgrade/test-assistance:
Assistance
----------
If you encounter an issue in the **test database**, please get in touch with Odoo Upgrade Support
via the `Odoo Support page <https://www.odoo.com/help>`_.
Under the *Ticket Description* section, select *An issue related to my upgrade* ticket type.
.. image:: process/test-assistance.png
:align: center
:alt: Selection of "An issue related to my upgrade" as Ticket Type in the support form on Odoo
.. warning::
If you choose another *Ticket Description* type, the request will be redirected to another
team. This will slow down the processing and response time.
Please provide as much detail as you can (i.e., videos and screenshots to illustrate your issue).
This will avoid clarifying questions and speed up the resolution process significantly.
.. image:: process/test-assistance-details.png
:align: center
:alt: "Detailed Description" field in the support form on Odoo
.. note::
* The purpose of the test phase is not to correct existing data or configurations in your
database.
* |assistance-contact|
.. _upgrade/steps-production:
The production launch
---------------------
.. _upgrade/production-live:
Production goes live
~~~~~~~~~~~~~~~~~~~~
The production upgrade request is when you decide to upgrade your current database with all your
production data (invoices, VAT returns, inventories, current orders) to a new version of your
choice.
After your :ref:`tests <upgrade/testing-phase>` are completed to your satisfaction, submit the
request to upgrade your production database via our `website form <https://upgrade.odoo.com>`_.
Select *Production* purpose.
.. image:: process/production-purpose.png
:align: center
:alt: Selection of the "Production" purpose in the upgrade form on Odoo
.. danger::
Going into production without first testing may lead to:
- business interruptions (e.g., no longer having the possibility to validate an action)
- poor customer experiences (e.g., an eCommerce website that does not work correctly)
.. _upgrade/production-assistance:
Assistance
~~~~~~~~~~
If you encounter issues or problems in the **production database**, please get in touch with **Odoo
Support**:
#. Connect to our `Odoo Support page <https://www.odoo.com/help>`_.
#. Under the *Ticket Description* section, select the appropriate type related to your issue but
**do not select** the option *An issue related to my upgrade*.
.. note::
After upgrading to production, the support will be provided by the Support team instead of the
Upgrade team.
#. Please provide as much detail as you can (i.e., videos and screenshots to illustrate your issue).
This will avoid clarifying questions and speed up the resolution process significantly.
.. image:: process/production-assistance-details.png
:align: center
:alt: "Detailed Description" field in the support form on Odoo
.. warning::
If you choose *An issue related to my upgrade* as ticket type, the request will be redirected
to another team than the support one and will slow down the processing and response time.
.. _upgrade/assistance:
Assistance
==========
.. _upgrade/contact:
Contact our Upgrade service support
-----------------------------------
Should you have any more questions about the upgrade, do not hesitate to send a message to `Odoo
Upgrade Team <mailto:upgrade@odoo.com>`_. We will be happy to answer it as soon as possible.
.. _upgrade/supported-versions:
Supported versions
------------------
Please note that Odoo provides support and bug fixing only for the three last major versions of
Odoo.
This is a factor to take into consideration before upgrading. If you are on an older version, we
suggest you to prefer the most recent version to benefit from longer support (before having to
upgrade again).
You can get more information about our :doc:`supported versions <../maintain/supported_versions>`.
.. seealso::
- :doc:`faq`
- :doc:`odoo_sh`
- :doc:`service_level`
- :doc:`../maintain/supported_versions`

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

View File

Before

Width:  |  Height:  |  Size: 2.8 KiB

After

Width:  |  Height:  |  Size: 2.8 KiB

View File

Before

Width:  |  Height:  |  Size: 8.7 KiB

After

Width:  |  Height:  |  Size: 8.7 KiB

View File

Before

Width:  |  Height:  |  Size: 2.9 KiB

After

Width:  |  Height:  |  Size: 2.9 KiB

View File

@ -0,0 +1,37 @@
.. |assistance-contact| replace::
If you need Odoo assistance on this matter, please get in touch with your Odoo Account Manager or
our `Sales department`_.
.. _Sales department: mailto:sales@odoo.com
=======================
Service Level Agreement
=======================
What is covered by the Enterprise Licence?
==========================================
Databases hosted on Odoos Cloud platforms (Saas and Odoo.sh) or On-Premise (Self-Hosting) enjoy the
following service at all times.
The upgrade of:
* standard applications
* Studio customization (as long as the Studio app is still active)
* customizations done by our consulting and developer services *if* they are covered by a
Maintenance of Customisations subscription
The Upgrade Service is limited to your database's technical conversion and adaptation (standard
modules and data) to make it compatible with the targeted version.
What upgrading does NOT cover
=============================
* The cleaning of pre-existing data & configuration while upgrading
* Any new developments and/or upgrades of your own :ref:`custom modules
<upgrade-faq/custom-modules>`
* `Training <https://www.odoo.com/learn>`_ on the latest version
You can get more information about your Enterprise Licence on our :ref:`Odoo Enterprise Subscription
Agreement <upgrade>` page.
.. note:: |assistance-contact|

View File

@ -10,4 +10,5 @@ Finance
finance/accounting
finance/expenses
finance/documents
finance/sign
finance/sign
finance/payment_acquirers

View File

@ -7,7 +7,7 @@ Webinars
Below you can find videos with a general description of the localization, and how to configure it.
- `VIDEO WEBINAR OF A COMPLETE DEMO <https://youtu.be/BOzucXRUZDE>`_.
- `VIDEO WEBINAR OF A COMPLETE DEMO <https://youtu.be/Y83p3YK1lFU>`_.
Introduction
============
@ -19,7 +19,7 @@ requires the next modules:
contains the default setup for: chart of accounts, taxes,
retentions, identification document types
#. **l10n_co_edi**: This module includes all the extra fields that are
required for the Integration with Carvajal T&S and generate the
required for the Integration with Carvajal and generate the
electronic invoice, based on the DIAN legal requirements.
@ -43,12 +43,12 @@ filter and search for "Colombia". Then click on *Install* for the first two modu
:align: center
Configure credentials for Carvajal T&S web service
--------------------------------------------------
Configure credentials for Carvajal web service
----------------------------------------------
Once that the modules are installed, in order to be able to connect
with Carvajal T&S Web Service, it's necessary to configure the user
and credentials, this information will be provided by Carvajal T&S.
with Carvajal Web Service, it's necessary to configure the user
and credentials, this information will be provided by Carvajal.
Go to :menuselection:`Accounting --> Configuration --> Settings` and
look for the *Colombian Electronic Invoice* section.
@ -56,12 +56,20 @@ look for the *Colombian Electronic Invoice* section.
.. image:: media/colombia03.png
:align: center
Using the Testing mode it is possible to connect with a Carvajal T&S
Using the Testing mode it is possible to connect with a Carvajal
testing environment. This allows users to test the complete workflow
and integration with the CEN Financiero portal, which is accessible
here: https://cenfinancierolab.cen.biz
here:
Once that Odoo and Carvajal T&S is fully configured and ready for
CTS (Carvajal T&S)
https://cenflab.cen.biz/site/
CSC (Carvajal Servicios de Comunicación)
https://web-stage.facturacarvajal.com/
CSC is the default for new databases.
Once that Odoo and Carvajal are fully configured and ready for
production the testing environment can be disabled.

View File

@ -18,7 +18,7 @@ requiere los siguientes Módulos:
- Tipos de Documentos de Identificación
#. **l10n_co_edi**: Este módulo incluye todos los campos adicionales que son
requeridos para la Integración entre Carvajal T&S y la generación de la
requeridos para la Integración entre Carvajal y la generación de la
Factura Electrónica, basado en los requisitos legales de la DIAN.
@ -42,12 +42,12 @@ Instalar a los primeros dos módulos:
:align: center
Configuración de las credenciales del Servicio Web de Carvajal T&S
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Configuración de las credenciales del Servicio Web de Carvajal
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| Una vez que los módulos están instalados, para poderte conectar con el
Servicio Web de Carvajal T&S, es necesario configurar el Usuario y las
Credenciales. Esta información será provista por Carvajal T&S.
Servicio Web de Carvajal, es necesario configurar el Usuario y las
Credenciales. Esta información será provista por Carvajal.
| Ve a :menuselection:`Facturación --> Configuración --> Configuración` y busca la sección
**Facturación Electrónica Colombiana**
@ -55,14 +55,21 @@ Configuración de las credenciales del Servicio Web de Carvajal T&S
:align: center
La funcionalidad de pruebas le permite conectarse e interactuar con el
ambiente piloto de Carvajal T&S, esto permite a los usuarios probar el
ambiente piloto de Carvajal, esto permite a los usuarios probar el
flujo completo y la integración con el Portal Financiero CEN, al cual
se accede a través de la siguiente liga: `Cenfinanciero <https://cenfinancierolab.cen.biz>`_.
se accede a través de la siguiente liga:
CTS (Carvajal T&S)
https://cenflab.cen.biz/site/
CSC (Carvajal Servicios de Comunicación)
https://web-stage.facturacarvajal.com/
CSC es el predeterminado para nuevas bases de datos.
Una vez que el ambiente de producción está listo en Odoo y en Carvajal
T&S el ambiente de pruebas debe ser deshabilitado para poder enviar la
información al ambiente de producción de Carvajal, para el cual es
utilizada la siguiente URL: `Cenfinanciero <https://cenfinancierolab.cen.biz>`_.
el ambiente de pruebas debe ser deshabilitado para poder enviar la
información al ambiente de producción de Carvajal.
Configuración de Información para PDF

View File

@ -2,44 +2,360 @@
France
======
FEC
===
.. _france/fec:
If you have installed the French Accounting, you will be able to download the FEC.
For this, go in :menuselection:`Accounting --> Reporting --> France --> FEC`.
FEC - Fichier des Écritures Comptables
======================================
An FEC :dfn:`Fichier des Écritures Comptables` audit file contains all the accounting data and entries
recorded in all the accounting journals for a financial year. The entries in the file must be
arranged in chronological order.
Since January 1st, 2014, every French company is required to produce and transmit this file upon
request by the tax authorities for audit purposes.
FEC Import
----------
To make the onboarding of new users easier, Odoo Enterprise's French :doc:`fiscal localization
<../overview/fiscal_localization_packages>` includes the **FEC Import** feature (module name:
``l10n_fr_fec_import``), which enables the import of existing FEC files from older software.
To enable this feature, go to :menuselection:`Accounting --> Configuration --> Settings -->
Accounting Import`, enable **FEC Import**, and *Save*.
Next, go to :menuselection:`Accounting --> Configuration --> FEC Import`, upload your FEC file, and
click on *Import*.
.. note::
| Importing FEC files from different year takes no particular action or computation.
| Should multiple files contain any "Reports à Nouveaux" (RAN) with the starting balance of the
year, you might need to cancel those entries in the User Interface. Odoo makes those entries
(RAN) useless.
File formats
~~~~~~~~~~~~
FEC files can only be in CSV format, as the XML format is not supported.
.. note::
The FEC CSV file has a plain text format representing a data table, with the first line being a
header and defining the list of fields for each entry, and each following line representing one
accounting entry, in no predetermined order.
Our module expects the files to meet the following technical specifications:
- **Encoding**: UTF-8, UTF-8-SIG and iso8859_15.
- **Separator**: any of these: `;` or `|` or `,` or `TAB`.
- **Line terminators**: both CR+LF (`\\r\\n`) and LF (`\\n`) character groups are supported.
- **Date format**: `%Y%m%d`
Fields description and use
~~~~~~~~~~~~~~~~~~~~~~~~~~
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
| # | Field name | Description | Use | Format |
+====+===============+======================================+===================================+=================+
| 01 | JournalCode | Journal Code | `journal.code` and `journal.name` | Alphanumeric |
| | | | if `JournalLib` is not provided | |
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
| 02 | JournalLib | Journal Label | `journal.name` | Alphanumeric |
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
| 03 | EcritureNum | Numbering specific to each journal | `move.name` | Alphanumeric |
| | | sequence number of the entry | | |
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
| 04 | EcritureDate | Accounting entry Date | `move.date` | Date (yyyyMMdd) |
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
| 05 | CompteNum | Account Number | `account.code` | Alphanumeric |
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
| 06 | CompteLib | Account Label | `account.name` | Alphanumeric |
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
| 07 | CompAuxNum | Secondary account Number | `partner.ref` | Alphanumeric |
| | | (accepts null) | | |
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
| 08 | CompAuxLib | Secondary account Label | `partner.name` | Alphanumeric |
| | | (accepts null) | | |
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
| 09 | PieceRef | Document Reference | `move.ref` and `move.name` | Alphanumeric |
| | | | if `EcritureNum` is not provided | |
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
| 10 | PieceDate | Document Date | `move.date` | Date (yyyyMMdd) |
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
| 11 | EcritureLib | Account entry Label | `move_line.name` | Alphanumeric |
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
| 12 | Debit | Debit amount | `move_line.debit` | Float |
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
| 13 | Credit | Credit amount | `move_line.credit` | Float |
| | | (Field name "Crédit" is not allowed) | | |
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
| 14 | EcritureLet | Accounting entry cross reference | `move_line.fec_matching_number` | Alphanumeric |
| | | (accepts null) | | |
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
| 15 | DateLet | Accounting entry date | unused | Date (yyyyMMdd) |
| | | (accepts null) | | |
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
| 16 | ValidDate | Accounting entry validation date | unused | Date (yyyyMMdd) |
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
| 17 | Montantdevise | Currency amount | `move_line.amount_currency` | Float |
| | | (accepts null) | | |
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
| 18 | Idevise | Currency identifier | `currency.name` | Alphanumeric |
| | | (accepts null) | | |
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
These two fields can be found in place of the others in the sence above.
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
| 12 | Montant | Amount | `move_line.debit` | Float |
| | | | or `move_line.credit` | |
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
| 13 | Sens | Can be "C" for Credit | determines `move_line.debit` | Char |
| | | or "D" for Debit | or `move_line.credit` | |
+----+---------------+--------------------------------------+-----------------------------------+-----------------+
Implementation details
~~~~~~~~~~~~~~~~~~~~~~
The following accounting entities are imported from the FEC files: **Accounts, Journals, Partners**,
and **Moves**.
Our module determines the encoding, the line-terminator character, and the separator that are used
in the file.
A check is then performed to see if every line has the correct number of fields corresponding to the
header.
If the check passes, then the file is read in full, kept in memory, and scanned. Accounting entities
are imported one type at a time, in the following order.
Accounts
********
Every accounting entry is related to an account, which should be determined by the field
`CompteNum`.
Code matching
*************
Should a similar account code already be present in the system, the existing one is used instead of
creating a new one.
Accounts in Odoo generally have a number of digits that are default for the fiscal localization. As
the FEC module is related to the French localization, the default number of relevant digits is 6.
This means that the account codes the trailing zeroes are right-trimmed, and that the comparison
between the account codes in the FEC file and the ones already existing in Odoo is performed only on
the first six digits of the codes.
.. example::
The account code `65800000` in the file is matched against an existing `658000` account in Odoo,
and that account is used instead of creating a new one.
Reconcilable flag
*****************
An account is technically flagged as *reconcilable* if the first line in which it appears has the
`EcritureLet` field filled out, as this flag means that the accounting entry is going to be
reconciled with another one.
.. note::
In case the line somehow has this field not filled out, but the entry still has to be reconciled
with a payment that hasn't yet been recorded, this isn't a problem anyway; the account is
flagged as reconcilable as soon as the import of the move lines requires it.
Account type and Templates matching
***********************************
As the **type** of the account is not specified in the FEC format, **new** accounts are created
with the default type *Current Assets* and then, at the end of the import process, they are
matched against the installed Chart of Account templates. Also, the *reconcile* flag is also
computed this way.
The match is done with the left-most digits, starting by using all digits, then 3, then 2.
.. example::
+------------+------------+-----------------+---------------------+---------------------+
| Name | Code | Full comparison | 3-digits comparison | 2-digits comparison |
+============+============+=================+=====================+=====================+
| Template | `400000` | `400000` | `400` | `40` |
+------------+------------+-----------------+---------------------+---------------------+
| CompteNum | `40100000` | `40100000` | `401` | `40` |
+------------+------------+-----------------+---------------------+---------------------+
| **Result** | | | | Match **found** |
+------------+------------+-----------------+---------------------+---------------------+
The type of the account is then flagged as *payable* and *reconcilable* as per the account template.
Journals
********
Journals are also checked against those already existing in Odoo to avoid duplicates, also in the
case of multiple FEC files imports.
Should a similar journal code already be present in the system, the existing one is used instead of
creating a new one.
New journals have their name prefixed by the string ``FEC-``.
.. example::
`ACHATS` -> `FEC-ACHATS`
The journals are *not* archived, the user is entitled to handle them as he wishes.
Journal type determination
**************************
The journal type is also not specified in the format (as per the accounts) and therefore it is
at first created with the default type `general`.
At the end of the import process, the type is determined as per these rules regarding related
moves and accounts:
- | `bank`: Moves in these journals always have a line (debit or credit) impacting a
liquidity account.
| `cash` / `bank` can be interchanged, so `bank` is set everywhere when this condition is met.
- | `sale`: Moves in these journals mostly have debit lines on receivable accounts and
credit lines on tax income accounts.
| Sale refund journal items are debit/credit inverted.
- | `purchase`: Moves in these journals mostly have credit lines on payable accounts and
debit lines on expense accounts.
| Purchase refund journal items are debit/credit inverted.
- | `general`: for everything else.
.. note::
- A minimum of three moves is necessary for journal type identification.
- A threshold of 70% of moves must correspond to a criteria for a journal type to be determined.
.. example::
Suppose we are analyzing the moves that share a certain `journal_id`.
+------------------------------------------------------------+-------+------------+
| Moves | Count | Percentage |
+============================================================+=======+============+
| that have a sale account line and no purchase account line | 0 | 0 |
+------------------------------------------------------------+-------+------------+
| that have a purchase account line and no sale account line | 1 | 25% |
+------------------------------------------------------------+-------+------------+
| that have a liquidity account line | 3 | **75%** |
+------------------------------------------------------------+-------+------------+
| **Total** | 4 | 100% |
+------------------------------------------------------------+-------+------------+
The journal `type` would be `bank`, because the bank moves percentage (75%) exceeds the threshold
(70%).
Partners
********
Each partner keeps its `Reference` from the field `CompAuxNum`.
.. note::
These fields are searchable, in line with former FEC imports on the accounting expert's side for
fiscal/audit purposes.
.. tip::
If you do not see the submenu **FEC**, go in **Apps** and search for the module
called **France-FEC** and verify if it is well installed.
Users can merge partners with the Data Cleaning App, where Vendors and Customers or similar
partner entries may be merged by the user, with assistance from the system that groups them by
similar entries.
Moves
*****
Entries are immediately posted and reconciled after submission, using the `EcritureLet` field to
do the matching between the entries themselves.
The `EcritureNum` field represents the name of the moves. We noticed that sometimes it may not be
filled out. In this case, the field `PieceRef` is used.
Rounding issues
***************
There is a rounding tolerance with a currency-related precision on debit and credit (i.e., 0.01 for
EUR). Under this tolerance, a new line is added to the move, named *Import rounding difference*,
targeting the accounts:
- `658000` Charges diverses de gestion courante, for added debits
- `758000` Produits divers de gestion courante, for added credits
Missing move name
*****************
Should the `EcritureNum` not be filled out, it may also happen that the `PieceRef` field is also
not suited to determine the move name (it may be used as an accounting move line reference) leaving
no way to actually find which lines are to be grouped in a single move, and effectively impeding the
creation of balanced moves.
One last attempt is made, grouping all lines from the same journal and date (`JournalLib`,
`EcritureDate`). Should this grouping generate balanced moves (sum(credit) - sum(debit) = 0), then
each different combination of journal and date creates a new move.
.. example::
`ACH` + `2021/05/01` --> new move on journal `ACH` with name `20210501`.
Should this attempt fail, the user is prompted an error message with all the move lines that are
supposedly unbalanced.
Partner information
*******************
If a line has the partner information specified, the information is copied to the accounting move
itself if the targeted Journal is of type *payable* or *receivable*.
Export
------
If you have installed the French :doc:`fiscal localization
<../overview/fiscal_localization_packages>`, you should be able to download the FEC. To do so, go to
:menuselection:`Accounting --> Reporting --> France --> FEC`.
.. tip::
If you do not see the submenu **FEC**, go to :menuselection:`Apps`, remove the *Apps* filter,
then search for the module named **France-FEC** and make sure it is installed.
.. seealso::
- `Official Technical Specification (fr)
<https://www.legifrance.gouv.fr/codes/article_lc/LEGIARTI000027804775>`_
- `Test-Compta-Demat (Official FEC Testing tool)
<https://github.com/DGFiP/Test-Compta-Demat>`_
French Accounting Reports
=========================
If you have installed the French Accounting, you will have access to some accounting reports specific to France:
If you have installed the French Accounting, you will have access to some accounting reports
specific to France:
- Bilan comptable
- Compte de résultats
- Plan de Taxes France
- Plan de Taxes France
Get the VAT anti-fraud certification with Odoo
==============================================
As of January 1st 2018, a new anti-fraud legislation comes into effect
in France and DOM-TOM. This new legislation stipulates certain criteria
concerning the inalterability, security, storage and archiving of sales data.
These legal requirements are implemented in Odoo, version 9 onward,
As of January 1st 2018, a new anti-fraud legislation comes into effect
in France and DOM-TOM. This new legislation stipulates certain criteria
concerning the inalterability, security, storage and archiving of sales data.
These legal requirements are implemented in Odoo, version 9 onward,
through a module and a certificate of conformity to download.
Is my company required to use an anti-fraud software?
-----------------------------------------------------
Is my company required to use anti-fraud software?
--------------------------------------------------
Your company is required to use an anti-fraud cash register software like
Your company is required to use an anti-fraud cash register software like
Odoo (CGI art. 286, I. 3° bis) if:
* You are taxable (not VAT exempt) in France or any DOM-TOM,
* Some of your customers are private individuals (B2C).
- You are taxable (not VAT exempt) in France or any DOM-TOM,
- Some of your customers are private individuals (B2C).
This rule applies to any company size. Auto-entrepreneurs are exempted from
This rule applies to any company size. Auto-entrepreneurs are exempted from
VAT and therefore are not affected.
Get certified with Odoo
@ -47,135 +363,143 @@ Get certified with Odoo
Getting compliant with Odoo is very easy.
Your company is requested by the tax administration to deliver a certificate
of conformity testifying that your software complies with the anti-fraud
legislation. This certificate is granted by Odoo SA to Odoo Enterprise users
Your company is requested by the tax administration to deliver a certificate
of conformity testifying that your software complies with the anti-fraud
legislation. This certificate is granted by Odoo SA to Odoo Enterprise users
`here <https://www.odoo.com/my/contract/french-certification/>`_.
If you use Odoo Community, you should :doc:`upgrade to Odoo Enterprise
</administration/maintain/enterprise>` or contact your Odoo service provider.
In case of non-conformity, your company risks a fine of €7,500.
To get the certification just follow the following steps:
To get the certification, just follow the following steps:
* If you use **Odoo Point of Sale**, :ref:`install <general/install>` the **France - VAT Anti-Fraud
- If you use **Odoo Point of Sale**, :ref:`install <general/install>` the **France - VAT Anti-Fraud
Certification for Point of Sale (CGI 286 I-3 bis)** module by going to :menuselection:`Apps`,
removing the *Apps* filter, then searching for *l10n_fr_pos_cert*, and installing the module.
* Make sure a country is set on your company, otherwise your entries wont be
- Make sure a country is set on your company, otherwise your entries wont be
encrypted for the inalterability check. To edit your companys data,
go to :menuselection:`Settings --> Users & Companies --> Companies`.
Select a country from the list; Do not create a new country.
* Download the mandatory certificate of conformity delivered by Odoo SA `here <https://www.odoo.com/my/contract/french-certification/>`__.
- Download the mandatory certificate of conformity delivered by Odoo SA `here <https://www.odoo.com/my/contract/french-certification/>`__.
.. note::
* To install the module in any system created before
December 18th 2017, you should update the modules list.
To do so, activate the :ref:`developer mode <developer-mode>`.
Then go to the *Apps* menu and press *Update Modules List* in the top-menu.
* In case you run Odoo on-premise, you need to update your installation
and restart your server beforehand.
* If you have installed the initial version of the anti-fraud module
(prior to December 18th 2017), you need to update it.
The module's name was *France - Accounting - Certified CGI 286 I-3 bis*.
After an update of the modules list, search for
the updated module in *Apps*, select it and click *Upgrade*.
Finally, make sure the following module *l10n_fr_sale_closing*
is installed.
- To install the module in any system created before
December 18th 2017, you should update the modules list.
To do so, activate the :ref:`developer mode <developer-mode>`.
Then go to the *Apps* menu and press *Update Modules List* in the top-menu.
- In case you run Odoo on-premise, you need to update your installation
and restart your server beforehand.
- If you have installed the initial version of the anti-fraud module
(prior to December 18th 2017), you need to update it.
The module's name was *France - Accounting - Certified CGI 286 I-3 bis*.
After an update of the modules list, search for
the updated module in *Apps*, select it and click *Upgrade*.
Finally, make sure the following module *l10n_fr_sale_closing*
is installed.
Anti-fraud features
-------------------
The anti-fraud module introduces the following features:
* **Inalterability**: deactivation of all the ways to cancel or modify
- **Inalterability**: deactivation of all the ways to cancel or modify
key data of POS orders, invoices and journal entries;
* **Security**: chaining algorithm to verify the inalterability;
* **Storage**: automatic sales closings with computation of both period
- **Security**: chaining algorithm to verify the inalterability;
- **Storage**: automatic sales closings with computation of both period
and cumulative totals (daily, monthly, annually).
Inalterability
~~~~~~~~~~~~~~
All the possible ways to cancel and modify key data of paid POS orders,
confirmed invoices and journal entries are deactivated,
if the company is located in France or in any DOM-TOM.
All the possible ways to cancel and modify key data of paid POS orders,
confirmed invoices and journal entries are deactivated,
if the company is located in France or in any DOM-TOM.
.. note:: If you run a multi-companies environment, only the documents of
such companies are impacted.
.. note::
If you run a multi-companies environment, only the documents of such companies are impacted.
Security
~~~~~~~~
To ensure the inalterability, every order or journal entry is encrypted
upon validation.
This number (or hash) is calculated from the key data of the document as
To ensure inalterability, every order or journal entry is encrypted
upon validation.
This number (or hash) is calculated from the key data of the document as
well as from the hash of the precedent documents.
The module introduces an interface to test the data inalterability.
If any information is modified on a document after its validation,
the test will fail. The algorithm recomputes all the hashes and compares them
against the initial ones. In case of failure, the system points out the first
The module introduces an interface to test the data inalterability.
If any information is modified on a document after its validation,
the test will fail. The algorithm recomputes all the hashes and compares them
against the initial ones. In case of failure, the system points out the first
corrupted document recorded in the system.
Users with *Manager* access rights can launch the inalterability check.
For POS orders, go to
:menuselection:`Point of Sales --> Reporting --> French Statements`.
For invoices or journal entries,
Users with *Manager* access rights can launch the inalterability check.
For POS orders, go to
:menuselection:`Point of Sales --> Reporting --> French Statements`.
For invoices or journal entries,
go to :menuselection:`Invoicing/Accounting --> Reporting --> French Statements`.
Storage
~~~~~~~
The system also processes automatic sales closings on a daily, monthly
The system also processes automatic sales closings on a daily, monthly
and annual basis.
Such closings distinctly compute the sales total of the period as well as
the cumulative grand totals from the very first sales entry recorded
Such closings distinctly compute the sales total of the period as well as
the cumulative grand totals from the very first sales entry recorded
in the system.
Closings can be found in the *French Statements* menu of Point of Sale,
Closings can be found in the *French Statements* menu of Point of Sale,
Invoicing and Accounting apps.
.. note::
* Closings compute the totals for journal entries of sales journals (Journal Type = Sales).
* For multi-companies environments, such closings are performed by company.
- Closings compute the totals for journal entries of sales journals (Journal Type = Sales).
* POS orders are posted as journal entries at the closing of the POS session.
Closing a POS session can be done anytime.
To prompt users to do it on a daily basis, the module prevents from resuming
a session opened more than 24 hours ago.
Such a session must be closed before selling again.
- For multi-companies environments, such closings are performed by company.
* A periods total is computed from all the journal entries posted after the
previous closing of the same type, regardless of their posting date.
If you record a new sales transaction for a period already closed,
it will be counted in the very next closing.
- POS orders are posted as journal entries at the closing of the POS session.
Closing a POS session can be done anytime.
To prompt users to do it on a daily basis, the module prevents from resuming
a session opened more than 24 hours ago.
Such a session must be closed before selling again.
.. tip:: For test & audit purposes such closings can be manually generated in the
:ref:`developer mode <developer-mode>`. Then go to :menuselection:`Settings -->
Technical --> Automation --> Scheduled Actions`.
- A periods total is computed from all the journal entries posted after the
previous closing of the same type, regardless of their posting date.
If you record a new sales transaction for a period already closed,
it will be counted in the very next closing.
.. tip::
- For test & audit purposes such closings can be manually generated in the
:ref:`developer mode <developer-mode>`.
- Then go to :menuselection:`Settings --> Technical --> Automation --> Scheduled Actions`.
Responsibilities
----------------
Do not uninstall the module! If you do so, the hashes will be reset and none
Do not uninstall the module! If you do so, the hashes will be reset and none
of your past data will be longer guaranteed as being inalterable.
Users remain responsible for their Odoo instance and must use it with
due diligence. It is not permitted to modify the source code which guarantees
Users remain responsible for their Odoo instance and must use it with
due diligence. It is not permitted to modify the source code which guarantees
the inalterability of data.
Odoo absolves itself of all and any responsibility in case of changes
in the modules functions caused by 3rd party applications not certified by Odoo.
Odoo absolves itself of all and any responsibility in case of changes
in the modules functions caused by 3rd party applications not certified by Odoo.
More Information
----------------
You will find more information about this legislation in the official documents:
You can find more information about this legislation in the following official documents.
* `Frequently Asked Questions <https://www.economie.gouv.fr/files/files/directions_services/dgfip/controle_fiscal/actualites_reponses/logiciels_de_caisse.pdf>`_
* `Official Statement <http://bofip.impots.gouv.fr/bofip/10691-PGP.html?identifiant=BOI-TVA-DECLA-30-10-30-20160803>`_
* `Item 88 of Finance Law 2016 <https://www.legifrance.gouv.fr/affichTexteArticle.do?idArticle=JORFARTI000031732968&categorieLien=id&cidTexte=JORFTEXT000031732865>`_
.. seealso::
- `Frequently Asked Questions
<https://www.economie.gouv.fr/files/files/directions_services/dgfip/controle_fiscal/actualites_reponses/logiciels_de_caisse.pdf>`_
- `Official Statement
<http://bofip.impots.gouv.fr/bofip/10691-PGP.html?identifiant=BOI-TVA-DECLA-30-10-30-20160803>`_
- `Item 88 of Finance Law 2016
<https://www.legifrance.gouv.fr/affichTexteArticle.do?idArticle=JORFARTI000031732968&categorieLien=id&cidTexte=JORFTEXT000031732865>`_

View File

@ -30,8 +30,7 @@ elettronica sono i seguenti:
di posta elettronica certificata sono fornite dal tuo fornitore o dal
Ministero. Lo stesso server deve essere configurato come server che
gestisce tutta la corrispondenza mail in Odoo, per saperne di più si
può consultare la relativa :doc:`guida
</applications/productivity/discuss/advanced/email_servers>`.
può consultare la relativa :doc:`guida </applications/general/email_communication/email_servers>`.
- Indirizzo PEC dellAzienda, tale indirizzo deve essere lo stesso
registrato presso lAgenzia delle Entrate per lutilizzo dei servizi

View File

@ -22,10 +22,6 @@ selected at the creation of the database.
To install a new package, go to :menuselection:`Accounting --> Configuration --> Fiscal
Localization`, click on **Install More Packages**, and install your country's module.
.. image:: media/fiscal_localization_packages_modules.png
:align: center
:alt: Install the appropriate module as fiscal localization package in Odoo Accounting.
Once done, select your country's package, and click on *Save*.
.. image:: media/fiscal_localization_packages_selection.png

View File

@ -6,10 +6,6 @@ Odoo Accounting can be used in many countries out of the box by installing the a
Here is a list of all :doc:`Fiscal Localization Packages <fiscal_localization_packages>` that are
available on Odoo.
.. image:: media/fiscal_localization_packages_modules.png
:align: center
:alt: Odoo Accounting.
Fiscal Localization Packages available
======================================

View File

@ -3,13 +3,17 @@ Digitize Vendor Bills with Optical Character Recognition (OCR)
==============================================================
Encoding bills manually can be a time-consuming task. Having a solution that allows you to digitize
them and automatically import the data to your database reduces errors and saves you time.
them and automatically import the data into your database reduces errors and saves you time.
.. important::
- Try it out! Upload one of your Bills or try one of our samples.
- Click `here <https://www.odoo.com/app/invoice-automation>`_ to evaluate it now!
Set up the feature
==================
Go to :menuselection:`Accounting --> Settings --> Bill Digitalization`, and choose whether the bills
should be processed automatically or manually.
should be processed automatically (use the OCR service every time) or manually (on demand).
.. image:: media/setup_ocr.png
:align: center
@ -41,7 +45,7 @@ Pricing
=======
| The *Bill Digitalization* is an *In-App Purchase (IAP)* service which requires prepaid credits to
work. Digitalizing one document consumes one credit.
work. Digitizing one document consumes one credit.
| To buy credits, go to :menuselection:`Accounting --> Configuration --> Settings --> Bill
Digitalization` and click on *Buy credits*, or go to :menuselection:`Settings --> Odoo IAP` and
click on *View My Services*.
@ -49,4 +53,4 @@ Pricing
.. important::
- If you are on Odoo Online (SAAS) and have the Enterprise version, you benefit from free trial
credits to test the feature.
- Click `here <https://iap.odoo.com/privacy#header_4>`_ to know about our *Privacy Policy*.
- Click `here <https://iap.odoo.com/privacy#header_4>`_ to learn more about our *Privacy Policy*.

View File

@ -17,7 +17,7 @@ Configuration
Make sure your :ref:`Payment Acquirers are correctly configured <payment_acquirers/configuration>`.
.. note::
By default, ":doc:`Wire Transfer </applications/general/payment_acquirers/wire_transfer>`" is the only
By default, ":doc:`Wire Transfer </applications/finance/payment_acquirers/wire_transfer>`" is the only
Payment Acquirer activated, but you still have to fill out the payment details.
To activate the Invoice Online Payment, go to :menuselection:`Accounting --> Configuration -->
@ -42,4 +42,4 @@ They can choose which Payment Acquirer to use by clicking on *Pay Now*.
.. seealso::
- :doc:`/applications/general/payment_acquirers`
- :doc:`/applications/finance/payment_acquirers`

View File

@ -7,4 +7,5 @@ Declarations
.. toctree::
:titlesonly:
declarations/tax_returns
declarations/tax_returns
declarations/intrastat

View File

@ -0,0 +1,29 @@
=========
Intrastat
=========
**Intrastat** is the system for data collection and statistic production of goods traded among the
EU Member States. Organizations whose annual trade surpasses a certain threshold must provide data
about the goods traded with other EU countries.
.. seealso::
- `Eurostat Statistics Explained - Glossary: Intrastat
<https://ec.europa.eu/eurostat/statistics-explained/index.php?title=Glossary:Intrastat>`_
.. note::
As of January 1, 2022, the reporting requirements have changed. One main modification concerns
the transaction codes which are now switching to a 2-digits format. All transactions recorded
after this date have to follow the new systems rules.
Configuration
=============
Go to :menuselection:`Accounting --> Settings --> Customer Invoices`, then enable **Intrastat** and
*Save*. Once the Intrastat has been activated you are able to choose the **Default incoterm**.
.. important::
If you created your Odoo database prior to **January 13, 2022**, please :ref:`upgrade
<general/upgrade>` the ``account_intrastat`` module to add the new transaction codes and
:ref:`install <general/install>` the ``account_intrastat_expiry`` module to archive the old
codes.

View File

@ -8,7 +8,6 @@ countries :
- **Balance Sheet**
- **Profit and Loss**
- **Chart of Account**
- **Executive Summary**
- **General Ledger**
- **Aged Payable**
@ -45,14 +44,6 @@ report period.
.. image:: media/main_reports10.png
:align: center
Chart of account
----------------
A listing of all your accounts grouped by class.
.. image:: media/main_reports08.png
:align: center
Executive Summary
-----------------

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

View File

@ -14,7 +14,7 @@ While this regulation mainly applies to :doc:`eCommerce <../../../../websites/ec
private EU consumers, it is also valid for mail order sales and telesales.
The Union **One-Stop Shop (OSS)** is an online portal where businesses can register for the OSS and
declare their intra-community distance sales. Each EU member states integrates an online OSS portal.
declare their intra-community distance sales. Each EU member state integrates an online OSS portal.
The **EU intra-community Distance Selling** feature helps your organization comply with this
regulation by creating and configuring new :doc:`fiscal positions <fiscal_positions>` and

View File

@ -43,6 +43,52 @@ In Odoo
and the zip code). Go to :menuselection:`Settings --> Users & Companies --> Companies`
to open and edit your Company record.
Automatically post taxes to the correct Tax Payable account
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* For each one of your companies that uses TaxCloud, it might be necessary to create a
**User-Defined Default** so that the new taxes generated by the TaxCloud integration are created
with the correct Tax Payable account:
.. warning::
A User-Defined Default impacts all records at creation. It means that **every** new tax will be
set up to record income in the specified Tax Payable account, unless the tax is manually edited
to specify a different income account (or there exists another User-Defined Default that takes
precedence).
* In :menuselection:`Accounting --> Configuration --> Chart of Accounts`, select the Tax Payable
account for the company. Take note of the account's ``id`` in the URL string.
.. image:: taxcloud/user-default-find-account-id.png
:alt: The account's ID can be found in the URL string as 'id=...'.
:align: center
* Activate the :ref:`developer mode <developer-mode>`, then go to
:menuselection:`Settings --> Technical --> Actions --> User-Defined Defaults`, and
click on *Create*.
* Click on *Field*, then, in the drop-down menu, on *Search More*.
.. image:: taxcloud/user-default-search-field.png
:alt: Click on 'Search More' in the 'Field' drop-down menu.
:align: center
* In the pop-up's search box, filter on the model ``tax.repartition.line`` and the field ``account``.
Select the ``account`` field of the ``tax.repartition.line`` model.
.. image:: taxcloud/user-default-select-field.png
:alt: Select the 'account' field of the 'tax.repartition.line' model.
:align: center
* In the **Default Value** field, enter the ID of the company's Tax Payable account.
Select the company for which this configuration should apply in the *Company* field.
Click *Save*.
.. image:: taxcloud/user-default-enter-default-account-id.png
:alt: Enter the ID of the company's Tax Payable account.
:align: center
How it works
============

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

View File

@ -21,7 +21,7 @@ Otherwise keep the cost at 0.0 and employees will report the real cost per expen
.. image:: expenses/product.png
:align: center
Here are some examples to configure:
Here are some examples:
* Restaurant:
@ -45,7 +45,7 @@ That way, employees report expenses with
prices including taxes, which is usually the expected behaviour.
.. tip::
The *Sales* app allows you to specify unit of measures for your
The *Sales* app allows you to specify units of measure for your
expense types (units, miles, nights, etc.).
Go to :menuselection:`Sales --> Configuration --> Settings` and check
*Some products may be sold/purchased in different units of measure (advanced)*.
@ -181,10 +181,10 @@ Setup
- Go to the product configuration menu and set the invoicing method on
all your Expense types:
- Ordered quantities : it will invoice expenses based on the ordered
- Ordered quantities: it will invoice expenses based on the ordered
quantity
- Delivered quantities :it will invoice expenses based on the
- Delivered quantities: it will invoice expenses based on the
expenses quantity
- At cost: will invoice expenses at their real cost.
@ -231,4 +231,4 @@ lines. Such items show up in blue (i.e. to invoice).
.. image:: expenses/invoicing_04.png
:align: center
e (i.e. to invoice).
e (i.e. to invoice).

View File

@ -0,0 +1,258 @@
:show-content:
=================================================
Payment acquirers (credit cards, online payments)
=================================================
.. toctree::
:titlesonly:
payment_acquirers/wire_transfer
payment_acquirers/adyen
payment_acquirers/alipay
payment_acquirers/authorize
payment_acquirers/buckaroo
payment_acquirers/mollie
payment_acquirers/ogone
payment_acquirers/paypal
payment_acquirers/sips
payment_acquirers/stripe
Odoo embeds several **payment acquirers** that allow your customers to pay on their *Customer
Portals* or your *eCommerce website*. They can pay sales orders, invoices, or subscriptions with
recurring payments with their favorite payment methods such as **Credit Cards**.
Offering several payment methods increases the chances of getting paid in time, or even immediately,
as you make it more convenient for your customers to pay with the payment method they prefer and
trust.
.. image:: payment_acquirers/online-payment.png
:align: center
:alt: Pay online in the customer portal and select which payment acquirer to use.
.. note::
Odoo apps delegate the handling of sensitive information to the certified payment acquirer so
that you don't ever have to worry about PCI compliance.
This means that no sensitive information (such as credit card numbers) is stored on Odoo servers
or Odoo databases hosted elsewhere. Instead, Odoo apps use a unique reference number to the data
stored safely in the payment acquirers' systems.
.. _payment_acquirers/supported_acquirers:
Supported payment acquirers
===========================
From an accounting perspective, we can distinguish two types of payment acquirers: the payment
acquirers that are third-party services and require you to follow another accounting workflow, and
the payments that go directly on the bank account and follow the usual reconciliation workflow.
.. _payment_acquirers/online_acquirers:
Online payment acquirers
------------------------
+-------------------------------+----------------------+------------+-----------------+-----------+
| | Payment flow | Save cards | Capture amount | Refund |
| | | | manually | from Odoo |
+===============================+======================+============+=================+===========+
| :doc:`Adyen | Payment from Odoo | |V| | | |V| |
| <payment_acquirers/adyen>` | | | | |
+-------------------------------+----------------------+------------+-----------------+-----------+
| :doc:`Alipay | Redirection to the | | | |
| <payment_acquirers/alipay>` | acquirer website | | | |
+-------------------------------+----------------------+------------+-----------------+-----------+
| :doc:`Authorize.Net | Payment from Odoo | |V| | |V| | |
| <payment_acquirers/authorize>`| | | | |
+-------------------------------+----------------------+------------+-----------------+-----------+
| :doc:`Buckaroo | Redirection to the | | | |
| <payment_acquirers/buckaroo>` | acquirer website | | | |
+-------------------------------+----------------------+------------+-----------------+-----------+
| :doc:`Mollie | Redirection to the | | | |
| <payment_acquirers/mollie>` | acquirer website | | | |
+-------------------------------+----------------------+------------+-----------------+-----------+
| :doc:`Ogone | Redirection to the | |V| | | |
| <payment_acquirers/ogone>` | acquirer website | | | |
+-------------------------------+----------------------+------------+-----------------+-----------+
| :doc:`PayPal | Redirection to the | | | |
| <payment_acquirers/paypal>` | acquirer website | | | |
+-------------------------------+----------------------+------------+-----------------+-----------+
| PayU Latam | Redirection to the | | | |
| | acquirer website | | | |
+-------------------------------+----------------------+------------+-----------------+-----------+
| PayUMoney | Redirection to the | | | |
| | acquirer website | | | |
+-------------------------------+----------------------+------------+-----------------+-----------+
| :doc:`SIPS | Redirection to the | | | |
| <payment_acquirers/sips>` | acquirer website | | | |
+-------------------------------+----------------------+------------+-----------------+-----------+
| :doc:`Stripe | Redirection to the | |V| | | |
| <payment_acquirers/stripe>` | acquirer website | | | |
+-------------------------------+----------------------+------------+-----------------+-----------+
.. |V| replace::
.. note::
Some of these online payment providers can also be added as :doc:`bank accounts
<../finance/accounting/bank/setup/bank_accounts>`, but this is **not** the same process as adding
them as payment acquirers. Payment acquirers allow customers to pay online, and bank accounts are
added and configured on your Accounting app to do a bank reconciliation, which is an accounting
control process.
.. _payment_acquirers/bank_payments:
Bank payments
-------------
- | :doc:`Wire Transfer <payment_acquirers/wire_transfer>`
| When selected, Odoo displays your payment information with a payment reference. You have to
approve the payment manually once you have received it on your bank account.
- | SEPA Direct Debit
| Your customers can sign a SEPA Direct Debit mandate online and get their bank account charged
directly. :doc:`Click here <../finance/accounting/receivables/customer_payments/batch_sdd>` for
more information about this payment method.
.. _payment_acquirers/configuration:
Configuration
=============
.. note::
Each acquirer has its specific configuration flow, depending on :ref:`which feature is available
<payment_acquirers/online_acquirers>`.
.. _payment_acquirers/add_new:
Add a new payment acquirer
--------------------------
To add a new payment acquirer and make it available to your customers, go to
:menuselection:`Accounting --> Configuration --> Payment Acquirers`, look for your payment acquirer,
install the related module, and activate it. To do so, open the payment acquirer and change its
state from *Disabled* to *Enabled*.
.. image:: payment_acquirers/activation.png
:align: center
:alt: Click on install, then on activate to make the payment acquirer available on Odoo.
.. warning::
We recommend using the *Test Mode* on a duplicated database or a test database. The Test Mode is
meant to be used with your test/sandbox credentials, but Odoo generates Sales Orders and Invoices
as usual. It isn't always possible to cancel an invoice, and this could create some issues with
your invoices numbering if you were to test your payment acquirers on your main database.
.. _payment_acquirers/credentials_tab:
Credentials tab
~~~~~~~~~~~~~~~
If not done yet, go to the online payment provider website, create an account, and make sure to have
the credentials required for third-party use. Odoo requires these credentials to communicate with
the payment acquirer.
The form in this section is specific to the payment acquirer you are configuring. Please refer to
the related documentation for more information.
.. _payment_acquirers/configuration_tab:
Configuration tab
~~~~~~~~~~~~~~~~~
You can change the payment acquirer's front-end appearance by modifying its name under the
**Displayed as** field and which credit card icons to display under the **Supported Payment Icons**
field.
.. _payment_acquirers/save_cards:
Save and reuse credit cards
***************************
With the **Save Cards** feature, Odoo can store **Payment Tokens** in your database, which can be
used for subsequent payments, without having to reenter the payment details. This is particularly
useful for the eCommerce conversion rate and subscriptions' recurring payments.
.. _payment_acquirers/capture_amount:
Place a hold on a card
**********************
If you wish to manually capture an amount instead of having an immediate capture, you can enable the
manual capture. Capturing payments manually has many advantages:
- Receive the payment confirmation and wait until the order is shipped to capture the payment.
- Review and verify that orders are legitimate before the payment is completed and the fulfillment
process starts.
- Avoid potentially high credit card fees in the event of overselling or cancelled orders.
The **Capture Amount Manually** field is under the **Configuration** tab. If enabled, the funds are
reserved for a few days on the customer's card, but not charged yet. Please refer to your acquirer's
documentation for the exact reservation duration.
.. image:: payment_acquirers/media/capture_manually.png
:align: center
:alt: Configuration tab on Odoo
To capture the payment, you must then go to the related sales order or invoice and manually
*capture* the funds before its automatic cancellation, or *void the transaction* to unlock the funds
from the customer's card.
.. image:: payment_acquirers/media/capture.png
:align: center
:alt: Hold the credit card payment until you capture or revoke it on Odoo
.. note::
Odoo may not yet support the manual capture for all acquirers, but some acquirers allow managing
the capture from their interfaces.
.. _payment_acquirers/countries:
Countries
*********
Restrict the use of the payment acquirer to a selection of countries. Leave this field blank to make
the payment acquirer available to all countries.
.. _payment_acquirers/journal:
Payment journal
***************
The **Payment journal** selected for your payment acquirer must be a *Bank* journal.
.. _payment_acquirers/accounting:
Accounting perspective
======================
The **Bank Payments** that go directly to one of your bank accounts follow their usual
reconciliation workflows. However, payments recorded with **Online Payment Providers** require you
to consider how you want to record your payments' journal entries. We recommend you to ask your
accountant for advice.
You need to select a *Payment Journal* on your acquirer configuration to record the payments,
on a **Outstanding Account**. The Journal's **type** must be *Bank Journal*.
You can use a single journal for many payment methods. And for each payment method, you can either:
- Define an **Accounting Account** to separate these payments from another payment method.
- Leave blank to fallback on the default account, which you can see or change in the settings.
.. image:: payment_acquirers/media/bank_journal.png
:align: center
:alt: A bank journal in the "Incoming Payments Tab".
You can have the same bank account for the whole company, or for some journals only, or a single
payment method... What best suit your needs.
.. seealso::
- :doc:`payment_acquirers/wire_transfer`
- :doc:`payment_acquirers/adyen`
- :doc:`payment_acquirers/alipay`
- :doc:`payment_acquirers/authorize`
- :doc:`payment_acquirers/buckaroo`
- :doc:`payment_acquirers/mollie`
- :doc:`payment_acquirers/ogone`
- :doc:`payment_acquirers/paypal`
- :doc:`payment_acquirers/sips`
- :doc:`payment_acquirers/stripe`
- :doc:`../websites/ecommerce/shopper_experience/payment_acquirer`

View File

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

View File

@ -0,0 +1,103 @@
=====
Adyen
=====
`Adyen <https://www.adyen.com/>`_ is a Dutch-based company that offers several online payment
possibilities.
Configuration
=============
.. seealso::
- :ref:`payment_acquirers/add_new`
Credentials tab
---------------
Odoo needs your **API Credentials** to connect with your Adyen account, which comprise:
- **Merchant Account**: The code of the merchant account to use with Adyen.
- :ref:`API Key <adyen/api_and_client_keys>`: The API key of the webservice user.
- :ref:`Client Key <adyen/api_and_client_keys>`: The client key of the webservice user.
- :ref:`HMAC Key <adyen/hmac_key>`: The HMAC key of the webhook.
- :ref:`Checkout API URL <adyen/urls>`: The base URL for the Checkout API endpoints.
- :ref:`Recurring API URL <adyen/urls>`: The base URL for the Recurring API endpoints.
You can copy your credentials from your Adyen account, and paste them in the related fields under
the **Credentials** tab.
.. important::
If you are trying Adyen as a test, with a *test account*, change the **State** to *Test Mode*. We
recommend doing this on a test Odoo database, rather than on your main database.
.. _adyen/api_and_client_keys:
API Key and Client Key
~~~~~~~~~~~~~~~~~~~~~~
In order to retrieve the API Key and the Client Key, log into your Adyen account, go to
:menuselection:`Developers --> API Credentials`.
- If you already have an API user, open it.
- If you don't have an API user yet, click on **Create new credential**.
Go to :menuselection:`Authentication` and get or generate your **API Key** and **Client Key**. Be
careful to copy your API key as you'll not be allowed to get it later without generating a new one.
This is also the place where you'll :ref:`allow payments to be made from your website
<adyen/allowed_origins>`.
.. _adyen/hmac_key:
HMAC key
~~~~~~~~
In order to retrieve the HMAC Key, you'll need to configure a `Standard Notification` webhook. For
this, log into your Adyen account then go to :menuselection:`Developers --> Webhooks --> Add webhook
--> Add Standard notification`.
.. image:: media/adyen_add_webhook.png
:align: center
:alt: Configure a webhook.
There, in :menuselection:`Transport --> URL`, enter your server address followed by
`/payment/adyen/notification`.
.. image:: media/adyen_webhook_url.png
:align: center
:alt: Enter the notification URL.
Then continue in :menuselection:`Additional Settings --> HMAC Key --> Generate new HMAC key`. Be
careful to copy it as you'll not be allowed to get it later without generating a new one.
You have to save the webhook to finalize its creation.
.. _adyen/urls:
URLs
~~~~
To retrieve the URLs, log into your Adyen account, go to :menuselection:`Developers --> API URLs`.
Pick one of the URLs listed next to **Recurring** as your **Recurring API URL** and one of the URLs
listed next to **Checkout API** as your **Checkout API URL**.
.. image:: media/adyen_api_urls.png
:align: center
:alt: Get the links for the different API.
Adyen Account
-------------
.. _adyen/allowed_origins:
Allow payments from a specific origin
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To allow payment originated from your website, follow the steps in :ref:`adyen/api_and_client_keys`
to navigate to your API user and go to :menuselection:`Allowed Origins`, then add the URLs from
where payments will be made (the URLs of the servers hosting your Odoo instances).
.. image:: media/adyen_allowed_origins.png
:align: center
:alt: Allows payments originated from a specific domain.
.. seealso::
- :doc:`../payment_acquirers`

View File

@ -0,0 +1,36 @@
======
Alipay
======
`Alipay <https://www.alipay.com/>`_ is an online payments platform established in China by Alibaba
Group.
Configuration
=============
.. seealso::
- :ref:`payment_acquirers/add_new`
Credentials tab
---------------
Odoo needs your **API Credentials** to connect with your Alipay account, which comprise:
- **Account**: Depending on where you are situated
- `Express Checkout` if your are a Chinese Merchant.
- `Cross-border` if you are not.
- **Alipay Seller Email**: Your public Alipay partner email (for express checkout only).
- **Merchant Partner ID**: The public partner ID solely used to identify the account with Alipay.
- **MD5 Signature Key**: The signature key.
You can copy your credentials from your Alipay account, and paste them in the related fields under
the **Credentials** tab.
To retrieve them, log into your Alipay account, they are on the front page.
.. important::
If you are trying Alipay as a test, in the *sandbox*, change the **State** to *Test Mode*. We
recommend doing this on a test Odoo database, rather than on your main database.
.. seealso::
- :doc:`../payment_acquirers`

View File

@ -0,0 +1,47 @@
=============
Authorize.Net
=============
`Authorize.Net <https://www.authorize.net>`_ is a United States-based online payment solution
provider, allowing businesses to accept **credit cards**.
Configuration
=============
.. seealso::
- :ref:`payment_acquirers/add_new`
Credentials tab
---------------
Odoo needs your **API Credentials & Keys** to connect with your Authorize.Net account, which
comprise:
- **API Login ID**: The ID solely used to identify the account with Authorize.Net.
- **API Transaction Key**
- **API Signature Key**
- **API Client Key**
To retrieve them, log into your Authorize.Net account, go to :menuselection:`Account --> Settings
--> Security Settings --> API Credentials & Keys`, generate your **Transaction Key** and
**Signature Key**, and paste them on the related fields in Odoo. Then, click on **Generate Client
Key**.
.. important::
If you are trying Authorize.Net as a test, with a *sandbox account*, change the **State** to
*Test Mode*. We recommend doing this on a test Odoo database, rather than on your main database.
Configuration tab
-----------------
Place a hold on a card
~~~~~~~~~~~~~~~~~~~~~~
With Authorize.net, you can enable the :ref:`manual capture <payment_acquirers/capture_amount>`. If
enabled, the funds are reserved for 30 days on the customer's card, but not charged yet.
.. warning::
After **30 days**, the transaction is **voided automatically** by Authorize.net.
.. seealso::
- :doc:`../payment_acquirers`

View File

@ -0,0 +1,47 @@
========
Buckaroo
========
`Buckaroo <https://www.buckaroo.eu/>`_ is a Dutch-based company that offers several online payment
possibilities.
Configuration
=============
.. seealso::
- :ref:`payment_acquirers/add_new`
Credentials tab
---------------
Odoo needs your **API Credentials** to connect with your Buckaroo account, which comprise:
- :ref:`Website Key <buckaroo/website_key>`: The key solely used to identify the website with
Buckaroo.
- :ref:`Secret Key <buckaroo/secret_key>`: The secret key you entered on Buckaroo.
You can copy your credentials from your Buckaroo account, and paste them in the related fields under
the **Credentials** tab.
.. _buckaroo/website_key:
Website Key
~~~~~~~~~~~
In order to retrieve the Website Key, log into your Buckaroo account, go to
:menuselection:`Configuration --> Templates --> Your Website`.
.. _buckaroo/secret_key:
Secret Key
~~~~~~~~~~
In order to retrieve the Website Key, log into your Buckaroo account, go to
:menuselection:`Configuration --> Security --> Secret Key`.
.. important::
If you are trying Buckaroo in a test account, change the **State** to *Test Mode*. We
recommend doing this on a test Odoo database, rather than on your main database.
.. seealso::
- :doc:`../payment_acquirers`

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

View File

Before

Width:  |  Height:  |  Size: 4.7 KiB

After

Width:  |  Height:  |  Size: 4.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.9 KiB

View File

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

View File

@ -0,0 +1,31 @@
======
Mollie
======
`Mollie <https://www.mollie.com/>`_ is an online payments platform established in the Netherlands.
Configuration
=============
.. seealso::
- :ref:`payment_acquirers/add_new`
Credentials tab
---------------
Odoo needs your **API Credentials** to connect with your Mollie account, which comprise:
- **API Key**: The test or live API Key depending on the configuration of the acquirer.
You can copy your credentials from your Mollie account, and paste them in the related fields under
the **Credentials** tab.
To retrieve your API key, log into your Mollie account, go to
:menuselection:`Developers --> API keys`, and copy your Test or Live **API Key**.
.. important::
If you are trying Mollie as a test, with the Test API key, change the **State** to *Test Mode*.
We recommend doing this on a test Odoo database, rather than on your main database.
.. seealso::
- :doc:`../payment_acquirers`

View File

@ -0,0 +1,88 @@
=====
Ogone
=====
`Ogone <https://www.ingenico.com/>`_, also known as **Ingenico Payment Services** is a France-based
company that provides the technology involved in secure electronic transactions.
Configuration on Odoo
=====================
.. seealso::
- :ref:`payment_acquirers/add_new`
Credentials tab
---------------
Odoo needs your **API Credentials** to connect with your Ogone account, which comprise:
- **PSPID**: The ID solely used to identify the account with Ogone. You chose it when you opened
your account.
- :ref:`API User ID <ogone/api_user>`: The ID solely used to identify the user with Ogone.
- :ref:`API User Password <ogone/api_user>`: Value used to identify the user with Ogone.
- :ref:`SHA Key IN <ogone/sha_key_in>`: Key used in the signature Odoo send to Ogone.
- :ref:`SHA Key OUT <ogone/sha_key_out>`: Key used in the signature Ogone send to Odoo.
You can copy your credentials from your Ogone account, and paste them in the related fields under
the **Credentials** tab.
.. _ogone/api_user:
API User ID and Password
~~~~~~~~~~~~~~~~~~~~~~~~
If you already created a user and have both its ID and password, just copy them. You can also
generate a new password from :menuselection:`Configuration --> Users --> Your chosen user --> change
password`.
If you don't have a user, create one by going to :menuselection:`Configuration --> Users -->
New User`. Set your **User ID** to get your **password** when you save your new user.
.. image:: media/ogone_new_user.png
:align: center
:alt: Get your password when you save the new user.
.. _ogone/sha_key_in:
SHA Key IN
~~~~~~~~~~
In order to retrieve the SHA Key IN, log into your ogone account, go to
:menuselection:`Configuration --> Technical Information --> Data and origin verification -->
Checks for e-Commerce & Alias Gateway`, and retrieve **SHA Key IN**.
.. _ogone/sha_key_out:
SHA Key OUT
~~~~~~~~~~~
In order to retrieve the SHA Key OUT, log into your ogone account, go to
:menuselection:`Configuration --> Technical Information --> Transaction feedback --> All transaction
submission modes`, and get or generate your **API Key** and **Client Key**. Be careful to copy your
API key as you'll not be allowed to get it later without generating a new one.
.. important::
If you are trying Ogone as a test, with the Test Account, change the **State** to *Test Mode*. We
recommend doing this on a test Odoo database, rather than on your main database.
Configuration on Ogone
======================
Now that Odoo can communicate with Ogone, we need to make sure that Ogone can send information to
your database.
To do so, log into your Ogone account and go to :menuselection:`Configuration --> Technical
Information --> Transaction feedback --> Direct HTTP server-to-server request`.
Then, fill the form with the following data:
- In the **Timing of the request**, select *Online but switch to a deferred request when the online
requests fail*.
- | Enter your Odoo databases URL in both **URLs** followed by ``/payment/ogone/return``.
| For example: ``https://yourcompany.odoo.com/payment/ogone/return``
- Select *POST* for the **Request Method**.
Save, and you are ready to go!
.. seealso::
- :doc:`../payment_acquirers`

View File

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

View File

@ -0,0 +1,144 @@
======
Paypal
======
`Paypal <https://www.paypal.com/>`_ is available and popular worldwide. It doesn't charge any
subscription fee, and creating an account is very easy. That's why we recommend it for starters in
Odoo. It works as a seamless flow where the customer is routed to the Paypal website to register the
payment.
Settings in Odoo
================
.. seealso::
- :ref:`payment_acquirers/add_new`
Credentials tab
---------------
Odoo needs your **API Credentials** to connect with your PayPal account, which comprise:
- **Email**: your login email address in Paypal.
- **Merchant Account ID**: the code of the merchant account used to identify your Paypal account.
- **PDT Identity Token**: the key used to verify the authenticity of transactions.
- **Use IPN**: whether you want to use Instant Payment Notification. Already checked, you don't have
to change it.
You can copy your credentials from your Paypal account and paste them into the related fields under
the **Credentials** tab.
To retrieve the **Merchant Account ID**, log into your Paypal account and go to
:menuselection:`Account menu --> Account Settings --> Business information`.
To set the **PDT Identity Token**, switch to :ref:`developer mode <developer-mode>` and retrieve the
token by following the configuration step :ref:`paypal/enable-pdt`.
.. important::
If you are trying Paypal as a test, using a :ref:`Paypal Sandbox account <paypal/testing>`,
change the **State** to *Test Mode*. We recommend doing this on a test Odoo database rather than
on your main database.
Configuration tab
-----------------
You can charge extra fees to your customers for paying with Paypal to cover the transaction fees
Paypal charges you. Once redirected to Paypal, your customer sees an extra amount applied to the
order amount.
To activate this, go to Paypal configuration's Configuration tab in Odoo and activate *Add Extra
Fees*.
You can refer to `Paypal Fees <https://www.paypal.com/webapps/mpp/paypal-fees>`_ to set up fees.
.. note::
`Traders in the EU <https://europa.eu/youreurope/citizens/consumers/shopping/pricing-payments/
index_en.htm>`_ are not allowed to charge extra fees for paying with credit cards.
Settings in Paypal
==================
First, set up your Paypal account to build a seamless customer experience with Odoo.
Log into your PayPal account and open the account settings. Then, go to :menuselection:`Account menu
--> Account settings --> Website payments`.
Enable Auto Return
------------------
The *Auto Return* feature automatically redirects your customers to Odoo once the payment is
processed.
From the *Website payments* settings page, go to :menuselection:`Website preferences --> Update -->
Auto return for website payments` and select **On**. Enter the address of your Odoo database (e.g.,
`https://yourcompany.odoo.com`) in the **Return URL** field.
.. note::
Any URL will do the job. Odoo only needs the setting to be enabled since it uses another URL.
.. _paypal/enable-pdt:
Enable Payment Data Transfer (PDT)
----------------------------------
Enable the *Payment Data Transfer* feature to receive payment confirmations immediately. This
feature also displays the payment status to the customers and verifies the authenticity of the
payments.
From the *Website payments* settings page, go to :menuselection:`Website preferences --> Update -->
Payment data transfer` and select **On**. PayPal displays your **PDT Identity Token** as soon as
the change is saved.
Paypal Account Optional
-----------------------
We advise you to not prompt customers to log in with a Paypal account when they get to pay. Let them
pay with debit/credit cards as well, or you might lose some deals. Make sure this setting is turned
on.
Payment Messages Format
-----------------------
Suppose you use accented characters (or anything else than primary Latin characters) for your
customer names or addresses. In that case, you **must** configure the encoding format of the payment
request sent by Odoo to Paypal. Otherwise, some transactions fail without notice.
To do so, go to `your production account <https://www.paypal.com/cgi-bin/customerprofileweb
?cmd=_profile-language-encoding>`_. Then, click *More Options* and set the two default encoding
formats as **UTF-8**.
Your Paypal account is ready!
.. tip::
- For Encrypted Website Payments & EWP_SETTINGS error, please check the `Paypal documentation
<https://developer.paypal.com/docs/classic/paypal-payments-standard/integration-guide/
encryptedwebpayments#encrypted-website-payments-ewp>`_.
- Configure your :ref:`Paypal Sandbox account <paypal/testing>`, then follow this
`link <https://sandbox.paypal.com/cgi-bin/customerprofileweb?cmd=_profile-language-encoding>`_
to configure the encoding format in a test environment.
.. _paypal/testing:
Test environment
================
Configuration
-------------
Thanks to Paypal Sandbox accounts, you can test the entire payment flow in Odoo.
Log into the `Paypal Developer Site <https://developer.paypal.com/>`_ using your Paypal
credentials, which creates two sandbox accounts:
- A business account (to use as merchants, e.g.,
`pp.merch01-facilitator@example.com <mailto:pp.merch01-facilitator@example.com>`_).
- A default personal account (to use as shoppers, e.g.,
`pp.merch01-buyer@example.com <mailto:pp.merch01-buyer@example.com>`_).
Log into Paypal Sandbox using the merchant account and follow the same configuration instructions.
Enter your sandbox credentials in Odoo and ensure Paypal is set on *Test Mode*. We recommend doing
this on a test Odoo database rather than your main database.
Run a test transaction from Odoo using the sandbox personal account.
.. seealso::
- :doc:`../payment_acquirers`

View File

@ -0,0 +1,32 @@
====
SIPS
====
`SIPS <https://sips.worldline.com/>`_ is an online payments solution from the multinational
Worldline.
Configuration
=============
.. seealso::
- :ref:`payment_acquirers/add_new`
Credentials tab
---------------
Odoo needs your **API Credentials** to connect with your SIPS account, which comprise:
- **Merchant ID**: The ID solely used to identify the merchant account with SIPS.
- **Secret Key**: The key to sign the merchant account with SIPS.
- **Secret Key Version**: The version of the key, pre-filled.
- **Interface Version**: Pre-filled, don't change it.
You can copy your credentials from your SIPS environment info documentation, in the section
**PROD**, and paste them in the related fields under the **Credentials** tab.
.. important::
If you are trying SIPS as a test, with the *TEST* credentials, change the **State** to *Test
Mode*. We recommend doing this on a test Odoo database, rather than on your main database.
.. seealso::
- :doc:`../payment_acquirers`

View File

@ -0,0 +1,135 @@
======
Stripe
======
`Stripe <https://stripe.com/>`_ is a United States-based online payment solution provider, allowing
businesses to accept **credit cards** and other payment methods.
Configuration
=============
.. seealso::
- :ref:`payment_acquirers/add_new`
Credentials tab
---------------
The method to acquire your credentials depends on your hosting type:
- On Odoo Online, please follow the onboarding.
- On Odoo.sh and On-premise, extra steps are required.
Odoo Online
~~~~~~~~~~~
#. Go to the **eCommerce** or the **Sales** app and click on the *Activate Stripe* or the *Set
payments* button on the onboarding banner.
#. Fill in the requested information and submit the form.
#. Confirm your email address when Stripe sends you a confirmation email.
#. At the end of the process, you are redirected to Odoo. If you submitted all the requested
information, you are all set and your payment acquirer is enabled.
.. tip::
To connect your Stripe account after the onboarding is already completed, go to
:menuselection:`Accounting --> Configuration --> Payment Acquirers --> Stripe` and click on the
*Connect Stripe* button.
.. tip::
To use your own :ref:`API keys <stripe/api_keys>`, :ref:`activate the Developer mode
<developer-mode>` and :ref:`enable Stripe manually <payment_acquirers/add_new>`.
Odoo.sh or On-premise
~~~~~~~~~~~~~~~~~~~~~
#. Go to the **eCommerce** or the **Sales** app and click on the *Activate Stripe* or the *Set
payments* button on the onboarding banner.
#. Fill in the requested information and submit the form.
#. Confirm your email address when Stripe sends you a confirmation email.
#. At the end of the process, you are redirected to the payment acquirer **Stripe** on Odoo.
#. :ref:`Fill in your credentials <stripe/api_keys>` and :ref:`generate a webhook <stripe/webhook>`.
Then, enable the payment acquirer.
.. tip::
To connect your Stripe account after the onboarding is already completed, go to
:menuselection:`Accounting --> Configuration --> Payment Acquirers --> Stripe` and click on the
*Connect Stripe* button.
.. important::
If you are testing Stripe (in **test mode**), change the **State** to *Test Mode*. We recommend
doing this on a test Odoo database rather than on your main database.
.. _stripe/api_keys:
Publishable and Secret keys
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Odoo needs your **API Credentials** to connect with your Stripe account, which comprises:
- :ref:`Publishable Key <stripe/api_keys>`: The key solely used to identify the account with Stripe.
- :ref:`Secret Key <stripe/api_keys>`: The key to sign the merchant account with Stripe.
- :ref:`Webhook Signing Secret <stripe/webhook>`: When you enable your webhook on your Stripe
account, this signing secret must be set to authenticate the messages sent from Stripe to Odoo.
To retrieve the publishable and secret keys, follow this `link to your API keys
<https://dashboard.stripe.com/account/apikeys>`_, or log into your Stripe dashboard and go to
:menuselection:`Developers --> API Keys --> Standard Keys`.
.. _stripe/webhook:
Webhook Signing Secret
~~~~~~~~~~~~~~~~~~~~~~
To retrieve the webhook signing secret, create a webhook either automatically or manually.
Create the webhook automatically
********************************
Make sure your :ref:`Publishable and Secret keys <stripe/api_keys>` are filled in, then click on the
*Generate your Webhook* button.
Create the webhook manually
***************************
Visit the `webhooks page on Stripe <https://dashboard.stripe.com/webhooks>`_, or log into your
Stripe dashboard and go to :menuselection:`Developers --> Webhooks`. Then, click on **Add endpoint**
in your **Hosted endpoints** and insert the following data into the pop-up form:
- | In the **Endpoint URL**, enter your Odoo database's URL followed by `/payment/stripe/webhook`.
| For example: `https://yourcompany.odoo.com/payment/stripe/webhook`
- At the end of the form, you can **Select events** to listen to. Click on it and, in the
**Checkout** section, select **checkout.session.completed**.
.. note::
It is possible to select other events, but they are currently not processed by Odoo.
When you click on **Add endpoint**, your Webhook is configured. You can then click on **reveal** to
display your signing secret.
.. _stripe/local-payment-methods:
Enable local payment methods
----------------------------
Local payment methods are payment methods that are only available for certain merchants and
customers countries and currencies.
Odoo supports the following local payment methods:
- Bancontact
- EPS
- giropay
- iDEAL
- Przelewy24 (P24)
To enable specific local payment methods with Stripe, list them as supported payment icons. To do
so, go to :menuselection:`Payment Acquirers --> Stripe --> Configuration` and add the desired
payment methods in the **Supported Payment Icons** field. If the desired payment method is already
listed, you don't have anything to do. If a payment icon record doesn't exist in the database, its
related payment method is considered enabled with Stripe.
.. image:: media/stripe_enable_local_payment_method.png
:align: center
:alt: Select and add icons of the payment methods you want to enable
.. seealso::
- :doc:`../payment_acquirers`

View File

@ -2,41 +2,38 @@
How to get paid with wire transfers
=======================================
**Wire Transfer** is the default payment method available.
The aim is providing your customers with your bank details
so they can pay on their own.
This is very easy to start with but slow and inefficient process-wise.
Opt for payment acquirers as soon as you can!
**Wire Transfer** is the default payment method available. The aim is providing your customers with
your bank details so they can pay on their own. This is very easy to start with but slow and
inefficient process-wise. Opt for payment acquirers as soon as you can!
How to provide customers with payment instructions
==================================================
Put your payment instructions in the **Thanks Message** of your payment method.
.. image:: media/payment_instructions.png
:align: center
:align: center
They will appear to the customers when they place an order.
.. image:: media/payment_customer_instructions.png
:align: center
:align: center
How to manage an order once you get paid
========================================
Whenever a customer pays by wire transfer, the order stays in an
intermediary stage **Quotation Sent** (i.e. unpaid order).
When you get paid,
you confirm the order manually to launch the delivery.
Whenever a customer pays by wire transfer, the order stays in an intermediary stage **Quotation
Sent** (i.e. unpaid order). When you get paid, you confirm the order manually to launch the
delivery.
How to create other manual payment methods
==========================================
If you manage a B2B business, you can create other manually-processed
payment methods like paying by check.
To do so, just rename *Wire Transfer* or duplicate it.
If you manage a B2B business, you can create other manually-processed payment methods like paying by
check. To do so, just rename *Wire Transfer* or duplicate it.
.. image:: media/payment_check.png
:align: center
:align: center
.. seealso::
- :doc:`../payment_acquirers`

View File

@ -1,5 +1,3 @@
:show-content:
====
Sign
====
@ -11,6 +9,9 @@ filled out with the user's detail if they are logged in.
.. seealso::
- `Odoo Sign: product page <https://www.odoo.com/app/sign>`_
- `Odoo Tutorials: Sign <https://www.odoo.com/slides/sign-61>`_
.. _sign/validity:
Validity of electronic signatures
=================================
@ -68,6 +69,53 @@ Overall, to be recognized as valid, electronic signatures have to meet five crit
.. note::
The information provided here does not constitute legal advice; it is provided for general
informational purposes only. As laws governing electronic signatures evolve rapidly, we cannot
guarantee that the information is up to date. We advise you to should contact a local attorney to
obtain legal advice.
informational purposes only. As laws governing electronic signatures rapidly evolve, we cannot
guarantee whether all information is up to date or not. We advise contacting a local attorney for
legal advice regarding electronic signature compliance and validity.
.. _sign/field-types:
Field Types
===========
By configuring your own *Field Types*, also known as *Signature Item Types*, you can make the
signing process even faster for your customers, partners, and employees.
To create and customize fields, activate the :ref:`developer mode <developer-mode>`. Then head to
:menuselection:`Documents --> Configuration --> Field Types` and click on *Create*.
After giving your new field a name, select one of the six *Types* available:
- **Signature**: users are prompted to enter their signature either by drawing it, automatically
generating one based on their name, or uploading a local file (usually an image). Each subsequent
*Signature* field then reuses the data entered in the first field.
- **Initial**: users are prompted to enter their initials, in a similar way to the *Signature*
field.
- **Text**: users enter text on a single line.
- **Multiline Text**: users enter text on multiple lines.
- **Checkbox**: users can tick a box (e.g.,to mark their approval or consent).
- **Selection**: users choose a single option from a variety of options.
Next, you have the option to auto-complete fields for users based on their Odoo profile information
by using *Automatic Partner Field*. To this end, the *Name*, *Email*, *Phone*, and *Company* fields
are preconfigured in your database.
.. note::
Users can freely edit auto-completed fields.
.. image:: sign/field-example.png
:align: center
:alt: Company field example in Odoo Sign
You can then change the size of the field by editing the *Default Width* and *Default Height*. Both
sizes are defined as a percentage of the full-page expressed as a decimal, with 1 equalling the
full-page's width or height. By default, the width of new fields you create is set to 15% (0.150)
of a full-page's width, while their height is set to 1.5% (0.015) of a full-page's height.
Next, write a *Tip*. Tips are displayed inside arrows on the left-hand side of the user's screen
during the signing process. You can also use a *Placeholder* text to be displayed inside the field
before it is completed.
.. image:: sign/tip-placeholder.png
:align: center
:alt: Tip and placeholder example in Odoo Sign

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Some files were not shown because too many files have changed in this diff Show More