Compare commits

...

157 Commits

Author SHA1 Message Date
luvi a9a067c4b9 [IMP] web: update usePosition API
This commit updates the documentation of the position hook, to add
the latest variant "fit". This variant was introduced recently in
commit (1), when using it in the SelectMenu component.

(1): https://github.com/odoo/odoo/commit/c21c415f3865b73c6dee9c9cf92224e684226f36
2023-01-07 15:51:55 +01:00
luvi 6df8b51cc7 [ADD] web: add useSpellCheck hook documentation
This commit brings the documentation for the useSpellCheck hook,
introduced in commit (1). The documentation contains some example
and details on how to use the hook properly.

(1): https://github.com/odoo/odoo/commit/130719e584d3ec817e43009e8b0f6a35ffff6177
2023-01-07 15:51:51 +01:00
Sam Lieber (sali) 076534b1f0 [ADD] maintain: setup mailjet api
closes odoo/documentation#3307

X-original-commit: 197a1cc932
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2023-01-06 16:34:17 +01:00
Antoine Vandevenne (anv) 49eb51b5d8 [FIX] odoo_theme: re-enable redirect fallback logic
closes odoo/documentation#3303

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-06 12:29:46 +01:00
Valentin Vallaeys (vava) da9c9aa1ab [IMP] payment_providers: add paragraph about currency field
The lists of supported currencies by payment provider are displayed on
the form view and are editable, because our list may not be up-to-date.
Empty lists stand for "no filtering" on the payment providers to access
payment methods.

task-2926016

closes odoo/documentation#2788

Related: odoo/enterprise#34158
Related: odoo/odoo#101018
Related: odoo/upgrade#4069
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-05 16:51:53 +01:00
Odoo's Mergebot d4f4e8684e [MERGE] odoo_theme: SCSS code clean up
In order to reduce the size of our css files:
Some unused or repeated code was found and removed.
Variables have been cleaned up, the way the admonitions (alerts) were created has been modified,

Expanding the use of BS variables in order to reduce repeated code and to stay consistent in the general design.
Sphinx was updated which made some changes in the DOM, breaking some of the CSS:
the literals for example, these have been fixed in this PR.
The font sizes were breaking the typescale, this has been fixed by modifying the typescale
rather than hardcoding font sizes.

closes odoo/documentation#3296

Forward-port-of: odoo/documentation#3293
Forward-port-of: odoo/documentation#3225
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-05 15:37:29 +01:00
Jorge Pinna Puissant 68a35753c6 [IMP] * : kanban, unify dropdown definition in archs
This commit add the documentation for the new 'kanban-menu' template
(the ellipsis dropdown menu).

No that, this commit add also the documentation for the 'kanban-tooltip'
template.

closes odoo/documentation#3284

Task-id: 3096776
Related: odoo/odoo#107589
Related: odoo/enterprise#34962
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-05 15:37:07 +01:00
Elisabeth Dickinson e74a893812 [IMP][CSS] Replace text-decoration on link with BS override 2023-01-05 12:53:11 +01:00
Elisabeth Dickinson 35230f0fc5 [IMP][CSS] Reorder styles according to styles guidelines 2023-01-05 12:53:11 +01:00
Elisabeth Dickinson 11aa498ed5 [IMP] fix typo 2023-01-05 12:53:11 +01:00
Elisabeth Dickinson fef7820521 [IMP] icon fixes 2023-01-05 12:53:11 +01:00
Elisabeth Dickinson 6d09d506b9 [IMP][CSS] Fix unresponsive font-size on alert text
By removing $font-size-sm on the alerts, the text is bigger. The title
text and its icon have been increased as well.
2023-01-05 12:53:11 +01:00
Elisabeth Dickinson d52966b147 [IMP][CSS] Remove browser prefixes and unnecessary mixins 2023-01-05 12:53:11 +01:00
Elisabeth Dickinson 530774b60b [IMP][CSS] Fix literals in alerts containing tabs 2023-01-05 12:53:11 +01:00
Elisabeth Dickinson ba0c7f42ba [IMP][CSS] Fix data indentation 2023-01-05 12:53:11 +01:00
Elisabeth Dickinson b65f74055f [IMP][CSS] Fix alignment on modal btn-close 2023-01-05 12:53:11 +01:00
Elisabeth Dickinson 93e7ee9673 [IMP] Indentation fix 2023-01-05 12:53:11 +01:00
Elisabeth Dickinson 8d6d1a7b3c [REM] Removal of changelog
The idea was not developed and it has since been decided not to do it.
2023-01-05 12:53:11 +01:00
Elisabeth Dickinson 21b1bf81b9 [IMP][CSS] Use BS font-weight variables and fix
Instead of redefining font-weights, we override the BS variables and add
one extra font-weight in the newly-introduced extended utilities file.
After this change all the variables needed replacing and some tweaking
was needed to get the same or closely similar result as before this
change.

By doing so the font-weight classes in the typography file were obsolete
and hence removed.
Some other font-weight issues which were already there have been fixed
in this commit too.
2023-01-05 12:53:11 +01:00
Elisabeth Dickinson f2c8501d8f [IMP][CSS] Fix color variable issue 2023-01-05 12:53:11 +01:00
Elisabeth Dickinson 699fdc0ceb [IMP][CSS] Revamp of the .o_spoiler element to use same code as alerts 2023-01-05 12:53:11 +01:00
Elisabeth Dickinson 61e5bf08b5 [IMP][CSS]Change order of imported scss files
The aim of this cleanup is to use as many bootstrap classes, functions
and utilities as possible to reduce the amount of extra code.
Instead of redefining variables, BS variables are overridden in the
bootstrap_overridden file.

In order to be able to reuse these overridden variables within our own
custom variable file — and after consultation with SRI — it was
determined that the variables.scss file should come after the bootstrap
files in the order of importation, unlike the order of odoo website's
scss files.

Changes to variables in bootstrap_overridden have been made to adapt to
the new structure.
2023-01-05 12:53:11 +01:00
Elisabeth Dickinson 6dbff460fb [IMP][CSS] Use CSS variables to style different alert types
CSS variables avoid having to repeat code for each alert type.
Also remove the need to add "tip" to the theme-colors (no need for "tip"
styled buttons, badges etc, especially as tips use the primary color) by
styling `.alert-tip` with customized copy of BS alert mechanism.

In order to be able to modify the icons with a CSS variable,
the `content` attribute has been removed from the `o-inline-icon` mixin.
Code where this mixin is called in other places has been adapted.
2023-01-05 12:53:11 +01:00
Elisabeth Dickinson 60ad2bdb7d [IMP][CSS] Place overrides in bootstrap_overridden file 2023-01-05 12:53:11 +01:00
Elisabeth Dickinson 35aaad62c9 [IMP][CSS] Clean up the file according to conventions
Includes reordering styles, renaming variables ($o-*),
re-indenting lines, removing commented code
2023-01-05 12:53:11 +01:00
Elisabeth Dickinson 9cd2ec28f7 [IMP][CSS] Set gray background to it's original darker color 2023-01-05 12:53:11 +01:00
Elisabeth Dickinson bed5b9edb7 [IMP][CSS] Improve literals styling (o_code, .sig-*) 2023-01-05 12:53:11 +01:00
Elisabeth Dickinson 5c931f7ec8 [IMP][CSS] Update _sphinx_basic.css after update of Sphinx
Note: Some code is commented instead of being deleted.
This allows us to keep track of what should be commented out in future
versions of Sphinx' basic CSS.
2023-01-05 12:53:10 +01:00
Elisabeth Dickinson b85a92be63 [IMP][CSS] Remove repetitive or unnused CSS 2023-01-05 12:53:10 +01:00
Elisabeth Dickinson e4afa7c177 [IMP][CSS] Improve margins on headings and sections 2023-01-05 12:53:10 +01:00
Elisabeth Dickinson a9d1450111 [IMP][CSS] Replace margin and padding values with variables 2023-01-05 12:53:10 +01:00
Elisabeth Dickinson 001fe6bd1e [IMP][CSS] Revamp modal to use all BS classes and variables 2023-01-05 12:53:10 +01:00
Elisabeth Dickinson 33cccf063f [IMP][CSS] Rescale heading fonts 2023-01-05 12:53:10 +01:00
Elisabeth Dickinson 4eab217696 [IMP][CSS] Cleanup font variables 2023-01-05 12:53:10 +01:00
Elisabeth Dickinson a85cb3bc92 [IMP][CSS] Cleanup admonitions (alerts) 2023-01-05 12:53:10 +01:00
Elisabeth Dickinson 1e0b95df13 [IMP][CSS] Cleanup color variables 2023-01-05 12:53:10 +01:00
Elisabeth Dickinson 778fbc37a6 [IMP][CSS] update literals styles (.o_code, .sig-*) 2023-01-05 12:53:10 +01:00
Antoine Vandevenne (anv) 2ef1219109 [IMP] odoo_theme: add the class o_code on literals
The SCSS that styles the `literal`, `code`, `file`, and `command` roles
is excessively complex because the traduction from RST to HTML is not
consistent from one role to another: some use `<code>` elements, some
have the `code` class, some wrap the literal with a `span` element.

This commit sets the `o_code` class on all of these roles' parent node
at translation time to allow simplifying the SCSS target.
2023-01-05 12:53:10 +01:00
Mahmoud Metwally 1a95d1cd6f Update qweb.rst
closes odoo/documentation#3289

X-original-commit: 8cde1f7b74
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-04 15:48:18 +01:00
Mahmoud Metwally 14be609d38 [FIX] rdtraining: fix writing errors
closes odoo/documentation#3276

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-04 11:35:54 +01:00
Sam Lieber (sali) a63621dc7a [FIX] maintain: correct cname definition
closes odoo/documentation#3281

X-original-commit: 96cbb2375b
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-01-03 23:42:51 +01:00
Jason (jaae) 5c8abb54b9 [IMP] project: adding description to app page
closes odoo/documentation#3274

X-original-commit: cfaf4386c2
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-01-03 21:23:00 +01:00
Antoine Vandevenne (anv) 4d51aecd95 [IMP] README: remove version from links and rephrase explanations
task-2897123

closes odoo/documentation#3265

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-03 20:14:55 +01:00
Antoine Vandevenne (anv) 872bee0033 [IMP] contributing/documentation: rewrite the contribution guide
This commit restructures the contributing/documentation page to re-use
content introduced with the contributing/development page and to
display the two ways to contribute (github vs git) in content tabs
rather than sections.

The guide is simplified and updated to delegate long explanations to
other pages or websites, remove useless images and focus on getting
users ready to contribute.

task-2897123

Part-of: odoo/documentation#3265
2023-01-03 20:14:55 +01:00
Antoine Vandevenne (anv) f778ba89af [ADD] contributing/development: add a guide to contribute to the codebase
In addition, this commit extracts the git guidelines from the coding
guidelines. This helps link the git guidelines and unclutter the coding
guidelines, which should focus on only the programming languages.

task-2897123

Part-of: odoo/documentation#3265
2023-01-03 20:14:55 +01:00
Julien Castiaux ca445c86c8 [IMP] core: additionnal country db for geoip
closes odoo/documentation#2151

Task: 2848206
Related: odoo/enterprise#27399
Related: odoo/odoo#91337
Signed-off-by: Julien Castiaux <juc@odoo.com>
Co-authored-by: Lau-Odoo <46811180+Lau-Odoo@users.noreply.github.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-03 13:15:55 +01:00
LoredanaLrpz 26364227a6 [IMP] pos: update tip info, remove and update screenshots
closes odoo/documentation#3253

Taskid: 3005150
X-original-commit: 4b258e1401
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-01-03 09:52:46 +01:00
Michelle Vu (mivu) 49e02a9097 [IMP] Calendar: Outlook sync warning
If committed, this will add a more elaborate warning on what users must
do before syncing Odoo Calendar and Outlook Calendar. It also removes
mentions of the import/export process and archiving events, as these
methods will not prevent email spam from Outlook.

closes odoo/documentation#3234

X-original-commit: 5979a772e6
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Michelle (mivu) <mivu@odoo.com>
2022-12-27 19:05:53 +01:00
Antoine Vandevenne (anv) 03573426e1 [FIX] odoo_theme: update the aria attributes when scrolling the page TOC
The 'aria-expanded' attribute was not correctly updated on the `i` tag
when the user scrolled through the page TOC. This caused a minor issue
where an arrow (`i`) that was collapsed manually with a click would no
longer automatically expand afterward.

task-3106339

closes odoo/documentation#3239

X-original-commit: f068065d39
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-27 13:18:14 +01:00
Antoine Vandevenne (anv) 520cd5fb9e [IMP] odoo_theme: expand top level menu items on the homepage
When the user browses the homepage, it might be hard to figure out
where they want to go next. Expanding the top-level menu items could
help them with that.

task-3106339

X-original-commit: 5526f1ea07
Part-of: odoo/documentation#3239
2022-12-27 13:18:13 +01:00
oco-odoo a88ce0cb9e [IMP] accounting: full documentation of the new report engine
Engine report for accounting.

closes odoo/documentation#3226

Taskid: 3042880
X-original-commit: bf2d3d9ed2
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-12-21 18:38:49 +01:00
Antoine Vandevenne (anv) 88a6ef872a [FIX] legal: fix path to PDF version of legal agreements
closes odoo/documentation#3220

X-original-commit: 3b80d99db7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-20 11:29:18 +01:00
Sam Lieber (sali) 90d76fabf7 [IMP] general: add notes about dev mode toggle
closes odoo/documentation#3212

X-original-commit: 54b903e512
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2022-12-19 18:53:45 +01:00
LoredanaLrpz f1e601a3a2 [IMP] POS: upgrade the getting started page for 16.0
Task ID: 3090486

closes odoo/documentation#3219

X-original-commit: 4ba98634b8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Perazzo Loredana (lrpz) <lrpz@odoo.com>
2022-12-19 16:48:53 +01:00
FrancoisGe e045da51b3 [IMP] web: adds the header to the list view
This commit adds the documentation related to the <header> tag to the list view.

closes odoo/documentation#3044

Related: odoo/odoo#106519
Related: odoo/enterprise#34387
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-16 18:40:01 +01:00
Zachary Straub (ZST) c619a6fca8 [IMP] email: add mail.default.from_filter
closes odoo/documentation#3211

X-original-commit: df041b1212
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Zachary Straub <zst@odoo.com>
2022-12-15 21:19:02 +01:00
Victor Feyens 992223a284 [FIX] core: latex build
* latest droid package does not allow \usepackage{droid} anymore,
replace it with the right package

See https://github.com/MiKTeX/miktex-packaging/issues/136

* remove reference to package texlive-generic-recommended since
it's not available nor necessary since ubuntu 20.04.

closes odoo/documentation#3204

X-original-commit: 816f437064
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-12-15 21:18:57 +01:00
fdardenne 90313bc380 [IMP] developer: JavaScript tutorial: enhance chapter 1
This commit adds several small information on chapter 1 of the training
 owl:

- 1.1 How to get to the playground controller
- 1.2 Add a reference on sub component
- 1.4 How to activate the dev mode in owl

closes odoo/documentation#3194

X-original-commit: 1bd7e803e0
Signed-off-by: Dardenne Florent (dafl) <dafl@odoo.com>
2022-12-15 08:37:50 +01:00
LoredanaLrpz cafdb815e3 [ADD] pos: Stripe payment terminal + link to doc in payment provider
Task ID: 2574495

closes odoo/documentation#3189

X-original-commit: 6b6104f081
Signed-off-by: Perazzo Loredana (lrpz) <lrpz@odoo.com>
2022-12-13 10:05:15 +01:00
Tom Aarab (toaa) b0ad5ac69e [IMP] odoo.sh: Python libraries and packages
Added a note on packages and extensions support

closes odoo/documentation#3188

Taskid: 2836438
X-original-commit: b1f92ba879
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2022-12-13 09:01:54 +01:00
Horacio Tellez eb8184542b [FIX] rdtraining: remove outdated line about journal_id in chapter 14
In chapter 14 there was a line pointing to how to deduce a default journal for an `account.move` record.
This is no longer needed as the journal is automatically deduced using the `move_type`. Also, the link
point to an outdated line of code that causes an error.

closes odoo/documentation#3183

X-original-commit: 67a75a3e11
Signed-off-by: Horacio Tellez Perez (hote) <hote@odoo.com>
2022-12-12 09:30:37 +01:00
Valentin Vallaeys (vava) 2ce56e4fb1 [FIX] developer: better definition for oe_inline
closes odoo/documentation#3173

X-original-commit: b2d0ab29a5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-09 21:01:00 +01:00
Antoine Vandevenne (anv) b3a1f27461 [IMP] conf.py, *: interpolate the version and releases in the content
This commit replaces hard-coded occurrences of the version and of the
last, current and next releases' version with placeholders interpolated
at build time to avoid manually updating these after each freeze.

task-2917614

closes odoo/documentation#3170

X-original-commit: fa2d0f6363
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-09 13:03:46 +01:00
fdardenne 8a0df31fc5 [IMP] developer: JavaScript tutorial: chapter 2
This commit adds the chapter 2 of the JavaScript tutorial.

This new tutorial allows people to discover Owl and the building blocks
of the Odoo JavaScript framework.

closes odoo/documentation#3164

X-original-commit: c5c6daef22
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Dardenne Florent (dafl) <dafl@odoo.com>
Co-authored-by: Géry Debongnie <ged@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-08 18:58:06 +01:00
KC (ksc) 124021800d [ADD] marketing automation: added 'getting started' section and docs to round out documentation
closes odoo/documentation#3162

X-original-commit: 4f6b03dc5b
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-12-08 16:59:01 +01:00
Antoine Vandevenne (anv) 2035a0b878 [IMP] contributing: list the ways to contribute to Odoo
task-2897123

closes odoo/documentation#3155

X-original-commit: a309372d83
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-12-08 15:51:24 +01:00
Donatienne Pirlot 52d7d84edb [IMP] accounting: different ways to record a payment
closes odoo/documentation#3148

X-original-commit: 7a57fb3c81
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-12-08 13:38:14 +01:00
Morgane (morm) 10bf041900 [IMP] documentation: legal page design
Prior to this commit, the terms and conditions were displayed in a table
with all the languages and it was not practical for the futur, with many
more languages.

task-3073198

closes odoo/documentation#3139

X-original-commit: a52a9eef2d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-08 12:31:09 +01:00
Donatienne Pirlot 882123671b [IMP] sign: update the documentation related to sign app
closes odoo/documentation#3119

X-original-commit: 64e952bbe1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-12-08 11:29:21 +01:00
jopa-odoo 7aef470156 [IMP] legal/fr: fix typos, spellcheck French translation
No changes to actual contents/semantics.

closes odoo/documentation#3138

X-original-commit: f9db0854b7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-12-08 01:41:55 +01:00
Zachary Straub (ZST) 2aa3b2d89a [IMP] CRM: updating flow and screenshots about lead mining
Task: 2543815
Cherry pick from #998

Omitted changes proposed in the **track_leads** directory (e.g. `lead_scoring.rst` + image folder). Both the content and image updates were already pushed from another PR so what was proposed on #998 was outdated and no longer necessary.

What’s left over are the original proposed changes in #998, within the **acquire_leads** directory which include updates to `lead_mining.rst` and corresponding image files.

On top of these proposals, I went ahead and made the following changes:

- renamed the image files in the asset directory, since they were using outdated naming convention (e.g. LM1.png, LM6.png, LM7.png)
- cleaned up rst formatting issues (headings, line breaks, added guilabels, etc.)
- rewrote document so content was more concise + followed content guidelines. You can see the first version of proposals here to compare the changes made.

closes odoo/documentation#3131

X-original-commit: 2416a2e5e9
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Zachary Straub <zst@odoo.com>
2022-12-07 18:29:20 +01:00
“Chiara b4a1a4a0d0 [ACC] accounting: Forecasting bills
closes odoo/documentation#3127

Tasikd: 3069519
X-original-commit: 939d40c16d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: chiaraprattico <chpr@odoo.com>
2022-12-07 15:32:09 +01:00
Jorge Pinna Puissant d0ae1cbce0 [IMP] views: setting view
This commit, add the documentation of the new DSL created exclusively
for the settings.

closes odoo/documentation#3092

Task-id: 3081367
Signed-off-by: Jorge Pinna Puissant (jpp) <jpp@odoo.com>
2022-12-07 11:49:50 +01:00
“Chiara 339b5dbfb6 [IMP] accounting: tax return
closes odoo/documentation#3117

X-original-commit: 1db9968faa
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: chiaraprattico <chpr@odoo.com>
2022-12-06 17:12:27 +01:00
Melanie Nguyen (meng) 914e339b37 [IMP] mail plugins: gmail plugin updates
Updated to reflect how to download Gmail Plugin from Google Workspace Marketplace for Odoo Online users; added new images

Closes Odoo Task 3001713

closes odoo/documentation#3111

X-original-commit: 88e00bf021
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-12-06 17:12:13 +01:00
Sam Lieber (sali) c58a06bede [IMP] accounting/l10n: AR update documentation
closes odoo/documentation#3107

X-original-commit: efb165d791
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-12-06 13:35:08 +01:00
Morgane (morm) b3b20ef355 [FIX] documentation: tabs responsiveness
Prior of this commit, the tabs were not responsive in the documentation

closes odoo/documentation#3081

X-original-commit: c9a001d22b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-06 12:00:45 +01:00
“Chiara 9b57df9a8d [IMP] accounting: SEPA
closes odoo/documentation#3100

Taskid: 2890089
X-original-commit: 5628762fae
Signed-off-by: Platteau Xavier (xpl) <xpl@odoo.com>
Signed-off-by: chiaraprattico <chpr@odoo.com>
2022-12-06 08:23:53 +01:00
LoredanaLrpz 90bc7cba78 [IMP] POS: improve the page - update text and screenshots
closes odoo/documentation#3089

Taskid: 3004917
X-original-commit: 8ae05b9a4b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Perazzo Loredana (lrpz) <lrpz@odoo.com>
2022-12-05 13:02:26 +01:00
Tom Aarab (toaa) 77a70dc8bf [IMP] Payment providers: advertise and document the "demo" provider
New page to document the new features of the demo payment provider, and
modifications to related pages

task id: 2982367

closes odoo/documentation#3088

X-original-commit: a1f4c3704b
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2022-12-03 09:52:51 +01:00
Tom Aarab (toaa) 0e22a3c582 [IMP] paypal: typo update
V14 has a dedicated "Fees" tab for PayPal, current documentation does not reflect that.

closes odoo/documentation#3087

Taskid: 3089273
X-original-commit: d774094e87
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2022-12-02 22:04:57 +01:00
LoredanaLrpz fc663c9a8c [IMP] pos: update and improve the page and screenshots
closes odoo/documentation#3073

Taskid: 3062150
X-original-commit: f2b8645a3c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Perazzo Loredana (lrpz) <lrpz@odoo.com>
2022-12-02 12:45:19 +01:00
fdardenne 2110671090 [ADD] developer: add a tutorial on Owl
This commit adds the introduction and the chapter 1 of the new
Owl/JavaScript framework tutorial.

This new tutorial allows people to discover Owl and the building blocks
of the Odoo JavaScript framework.

closes odoo/documentation#3069

X-original-commit: 62051b643f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Géry Debongnie <ged@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-02 10:11:21 +01:00
“Chiara 3289d1a1c7 [IMP] accounting: update payments by check
closes odoo/documentation#3068

Taskid: 3062532
X-original-commit: 528d16c611
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: chiaraprattico <chpr@odoo.com>
2022-12-02 09:10:57 +01:00
Sam Lieber (sali) 7062012490 [ADD] discuss: specific email server from
closes odoo/documentation#2993

X-original-commit: ce1d0b216d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2022-11-30 16:07:46 +01:00
Jonathan Castillo (jcs) 9491605213 [IMP] contribution: typo in documentation.rst
closes odoo/documentation#3056

X-original-commit: f0fa7a2e22
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-11-30 15:06:25 +01:00
Antoine Vandevenne (anv) 6be97f3219 [IMP] contributing/documentation: suggest to clone with ssh
GitHub requires users to "use token-based authentication for all
authenticated operations", for example `git push`. See
https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/

This commit suggests new contributors to clone the repository with SSH
so that the remote URL is automatically configured with the SSH
protocol.

task-3036845

closes odoo/documentation#3042

X-original-commit: dfb7801484
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-29 15:22:41 +01:00
Wesley Kao (weka) 6f9ee7b414 [IMP] MRP: updated Kits doc rst content
Went through the existing kits documentation and changed a lot of the
content, as much of it was outdated. Also replaced the images with new
ones.

closes odoo/documentation#2997

X-original-commit: 426b66ec7b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: weka-odoo <weka@odoo.com>
2022-11-28 18:51:44 +01:00
“Chiara bfadc58fbc [IMP] accounting: batch payments sdd
Forward to 16.0

closes odoo/documentation#3037

X-original-commit: d8f9c121ff
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: chiaraprattico <chpr@odoo.com>
2022-11-25 18:55:08 +01:00
Victor Feyens 2d1361c026 [FIX] developer/*: code blocks linting & fixes
invalid xml
invalid python
correct indentation

closes odoo/documentation#3029

X-original-commit: b2121b7891
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-25 10:52:04 +01:00
Victor Feyens 2b75fb4bbb [FIX] developer/*: consistent code-block language specification
X-original-commit: 387cf15e7f
Part-of: odoo/documentation#3029
2022-11-25 10:52:04 +01:00
Donatienne Pirlot aef7d05dc5 [IMP] Documents: improve and update the Documents documentation
closes odoo/documentation#3030

Id: 2899532
X-original-commit: 84e900f0f3
Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
2022-11-25 08:52:09 +01:00
Ivan Kropotkin 6c7ee83bc4 [FW][FIX] developer/reference: code example
closes odoo/documentation#3028

Forward-port-of: odoo/documentation#2943
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-24 19:25:27 +01:00
Jeff Nyalik 963de80d3e [FW][FIX] rdtraining: fix typo
Kind of a typo here " it will not possible" to "it will not be possible"

closes odoo/documentation#3023

Forward-port-of: odoo/documentation#3016
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-23 21:56:06 +01:00
Loan (lse) c2959cefce [IMP] point_of_sale: Adyen Event URLs configuration
Add more details as of how to set Adyen Event URLs.
This is important to configure as it is necessary to
receive a callback from Adyen terminal when a transaction
have been done.

OPW-3041117
OPW-3041117

closes odoo/documentation#3022

X-original-commit: aa9126b037
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-11-23 21:01:52 +01:00
Tori (vpk) dc6c4986d6 [ADD] Sales: new doc about returns and refunds
Task Number: 2514789

closes odoo/documentation#2989

X-original-commit: be0a995e21
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-23 18:15:42 +01:00
Donatienne Pirlot efe7cbcd26 [IMP] upgrade: updating screenshots and process steps
closes odoo/documentation#3015

X-original-commit: f0f6083ee5
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-11-22 20:50:30 +01:00
william-andre 7b7f79073a [IMP] cli: suggest auto complete script
Add a hint to how to build autocompletion values for odoo-bin

closes odoo/documentation#3010

X-original-commit: 025e365a9b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: William André (wan) <wan@odoo.com>
2022-11-22 18:12:33 +01:00
Victor Feyens f6ac437b68 [IMP] developer/howtos: deprecate themes tutorial
This tutorial was already outdated in 13.0 (but
supposedly working).

In 14.0+, a lot of changes happened in website logic,
especially for 'website option definitions', breaking
the existing theme tutorial.

Considering the fact that a new tutorial is being made,
and that fixing the whole existing tutorial would be
a big work, it will be kept, but hidden as 'most things
being said still make sense'.

closes odoo/documentation#3006

X-original-commit: 9cc60baf46
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-21 22:20:35 +01:00
Victor Feyens 17fa2e0333 [FIX] developer/mobile: use spaces and not tabs for indentation
closes odoo/documentation#2984

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-18 18:04:50 +01:00
Victor Feyens 197dbea3d2 [FIX] *: unbalanced literal markups
Part-of: odoo/documentation#2984
2022-11-18 18:04:50 +01:00
Victor Feyens c2f8d4bd44 [FIX] *: remove trailing whitespaces
Part-of: odoo/documentation#2984
2022-11-18 18:04:50 +01:00
Victor Feyens c60bc5f919 [FIX] *: enforce 1 newline on files end
Part-of: odoo/documentation#2984
2022-11-18 18:04:49 +01:00
Julien Castiaux 31aacc1791 [FIX] deploy.rst: nginx config for static files
In case of a source install the various places where static files can be
found are spread on the filesystem. The previous configuration sample
used custom internal locations but it turns out that it is only possible
to `try_files` on filesystem paths and on "named location (@ ones)".

This commit fixes the configuration sample so that it works for the
given situation where community and enterprise has been cloned from git.

task-3049538

closes odoo/documentation#2945

X-original-commit: 67cb3acd6a
Signed-off-by: Julien Castiaux <juc@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-18 12:57:55 +01:00
Wesley Kao (weka) b208529745 [IMP] MRP: updated bills of materials rst content
Reviewed the 15.0 doc for Bills of Materials and made some edits to
clean up inconsistencies and made minor wording changes.

closes odoo/documentation#2966

X-original-commit: 1645e8c3da
Signed-off-by: Zachary Straub <zst@odoo.com>
2022-11-17 20:06:39 +01:00
Victor Feyens 5e3d4d0414 [CLN] core: upgrade to python 3.6
& sort imports

closes odoo/documentation#2976

X-original-commit: 57784a2f90
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-17 11:58:56 +01:00
Donatienne Pirlot 73730b3cf5 [IMP] accounting: ai powered document digitization page updated
ID: 2989846

If you feel that it might help a future reader to understand your commit

closes odoo/documentation#2953

X-original-commit: e381c454a2
Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
2022-11-15 19:21:54 +01:00
Donatienne Pirlot cab1a56722 [IMP] accounting: update the doc related to internal transfers
closes odoo/documentation#2951

Id: 2901915
X-original-commit: d36bacb54a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
2022-11-15 18:25:34 +01:00
Donatienne Pirlot aced62f4b3 [ADD] accounting: provide information on the tax carryover feature
closes odoo/documentation#2947

X-original-commit: cc65809ec5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
2022-11-15 18:25:31 +01:00
jopa-odoo 68b2aa6df4 [IMP] Legal: Update Dutch translation
Update of the Dutch translation of Odoo Enterprise Subscription agreemnt
2022-11-15 17:53:33 +01:00
Christophe Monniez ce9072f27a [FIX] install: update 15.0 references to 16.0
closes odoo/documentation#2944

X-original-commit: 62f9a96972
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-14 17:18:08 +01:00
Loan (lse) 35e09b26c1 [IMP] iot: Add part regarding screen
Add  more details as of how to connect a screen to the IoT box
and how it can be used.

OPW-2962462

closes odoo/documentation#2940

X-original-commit: 21edc4fcc7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-14 13:02:03 +01:00
Tom Aarab (toaa) c69596bebc [IMP] accounting: updated chart of accounts v15
Creating account groups part was outdated.

task id: 2950820

closes odoo/documentation#2933

X-original-commit: 60ad93ea31
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2022-11-10 18:51:43 +01:00
Tom Aarab (toaa) 87facd654d [IMP] TaxCloud: updated doc
Changed out-of-date function and updated doc/changed grammar. Forward up to 16 (16 exluded)

task id: 2909436

closes odoo/documentation#2908

X-original-commit: 7cf109db1e
Signed-off-by: Platteau Xavier (xpl) <xpl@odoo.com>
2022-11-08 10:39:54 +01:00
Tom Aarab (toaa) 6725754169 [IMP] accounting: updated multiple payments page
Previous page was based on V13. Forward up to 16.

closes odoo/documentation#2919

Taskid: 3045197
X-original-commit: e4839ea7e9
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-07 13:50:26 +01:00
Tom Aarab (toaa) cabd6e7f85 [IMP] accounting: updated bank statement page
Previous version used V13 screenshots.

task - 2902004

closes odoo/documentation#2914

X-original-commit: de7fddab6c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-07 11:27:04 +01:00
Chong Wang (cwg) d4923d6350 [IMP] orm/changelog: store translations in jsonb
closes odoo/documentation#2901

X-original-commit: f2fd03b8fc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-03 16:43:31 +01:00
Xavier 8db94fe7fe [ADD] Studio: PDF reports
closes odoo/documentation#2895

Id: 2978638
X-original-commit: 5ad9d5eb0b
Signed-off-by: Platteau Xavier (xpl) <xpl@odoo.com>
2022-11-02 21:17:01 +01:00
“Chiara 5d7209d635 [IMP] accounting: Bank Synchronization: automatic import
closes odoo/documentation#2900

X-original-commit: 7fb5a21d64
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-02 19:19:53 +01:00
Antoine Vandevenne (anv) a154e01cee [IMP] extensions/spoilers: add an extension for spoilers
It is often needed in developer tutorials to show excerpts of code for
examples and solutions. This takes quite some page space and, for the
latter, it is not always desired to show the final code result right
after the exercise objective.

This commit adds a spoiler feature to the documentation to allow hiding
content until the reader wants to display it.

The feature relies on the new `.. spoiler:: Button label` directive.

task-3036845

closes odoo/documentation#2877

X-original-commit: 4d7a88639a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Morgan Meganck <morm@odoo.com>
Co-authored-by: Stefano Rigano <sri@odoo.com>
2022-10-28 14:21:05 +02:00
stefanorigano (SRI) ece2d4c081 [IMP] odoo_theme: add default BS functions
Prior to this change it was not possible to use Bootstrap default SCSS
functions in 'bootstrap_overridden.scss'.

This commit mirrors odoo framework's architecture, injecting bootstrap
'_functions.scss' at the beginning of the documentation's SCSS "bundle".

Commit preparatory to the introduction of the 'Spoiler' documentation
component.

task-3036845

X-original-commit: 1691e8970b
Part-of: odoo/documentation#2877
2022-10-28 14:21:04 +02:00
Donatienne Pirlot 57f447e302 [IMP] accounting: update and improve the cash basis taxes documentation
closes odoo/documentation#2872

Id: 2381690
X-original-commit: 8770938a97
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-28 14:20:56 +02:00
Donatienne Pirlot 7858ac6c68 [IMP] accounting: update the bank accounts documentation
ID:2607774

closes odoo/documentation#2881

X-original-commit: 285252d1fd
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-10-28 13:23:09 +02:00
Olivier Dony e56bc8a5b9 [IMP] legal: OE v10a - clarified wording for Section 5.1
The "(at that time") wording could be confusing - the goal was really to
refer to the price at the time of the deviation, not the price at the
conclusion of the agreement. This should be clearer.

Validated with SBR.
2022-10-27 18:14:27 +02:00
Xavier Morel 18c2c74848 [REM] reference: long deprecated SavepointCase
closes odoo/documentation#2844

Related: odoo/enterprise#33244
Related: odoo/odoo#98138
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-26 19:03:50 +02:00
Victor Feyens e63b92a718 [FIX] developer/cli: remove unsupported cli options
Removed by https://github.com/odoo/odoo/commit/c0647b5c527440cf9f94b51f1c9a9c4d1f3b508e

Fixes odoo/odoo#104060

closes odoo/documentation#2863

X-original-commit: 1225c93112
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-26 01:58:48 +02:00
Victor Feyens ac813f2b5b [FIX] developer/guidelines: do not mention deprecated xml tags
act_window & report xml tags have been deprecated by
https://github.com/odoo/odoo/commit/6835aeb0de6895f7f4d6b23e0b4654465ef21d6a
two years ago, we should avoid mentioning them in the guidelines.

Furthermore, in 17.0 they won't be available anymore.

closes odoo/documentation#2862

X-original-commit: 758463edd4
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-25 21:20:53 +02:00
Zachary Straub (ZST) 6419980663 [IMP] inventory: thd batch updates
closes odoo/documentation#2855

X-original-commit: ac3ec17266
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-25 21:20:45 +02:00
niyasraphy 894e1be9c6 [IMP] report_barcode function: parameter type to barcode_type
https://github.com/odoo/odoo/commit/ee324e8374536cebca4d7302210b07e8f33d3852

closes odoo/documentation#2847

X-original-commit: 3f34c3874c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-24 18:59:30 +02:00
Christophe Monniez 59db0ca18c [FIX] install: update installation from the nightly debian repo
As the `apt-key` command will is deprecated and will be removed in the
next Debian release, it's time to update the documentation.

closes odoo/documentation#2846

X-original-commit: 1c2d59b280
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-24 17:07:13 +02:00
Jonathan Castillo (jcs) ab1a7d0a69 [IMP] *: Remove "SaaS" to keep only the "Odoo Online" appellation
task-3034812

closes odoo/documentation#2839

X-original-commit: 9b69e0d77e
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-10-21 20:00:56 +02:00
Jonathan Castillo (jcs) 06d0ff6ca8 [IMP] *: consistency for the use of "Odoo Online" (and SaaS)
task-3034812

X-original-commit: 2c17b6fb4a
Part-of: odoo/documentation#2839
2022-10-21 20:00:55 +02:00
Xavier Morel 219a7cc82f [ADD] reference/orm: grouped method
closes odoo/documentation#2783

Related: odoo/odoo#101522
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-21 13:06:06 +02:00
nbe-odoo b9217c292a [FIX] website: rst and file organization for plausible.rst
- external links
- notes
- indentation
- media filenames
- images compression
- images alt tags
- light content improvement

closes odoo/documentation#2831

X-original-commit: 87392b7262
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Co-authored-by: Nicolas Bebawi (nbe) <nbe@odoo.com>
Co-authored-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2022-10-20 17:17:18 +02:00
zzk2000 814917793a [FW][FIX] administration/install: Odoo 16 distribution link
closes odoo/documentation#2830

Forward-port-of: odoo/documentation#2817
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-20 17:17:15 +02:00
tsm-odoo 7423cfa8f8 [IMP] install: add $connection_upgrade map documentation
Before this commit, following the install documentation to setup
the odoochat server would fail. This was due to the fact that the
documentation about how to define the `$connection_upgrade` variable
was missing.

This PR fixes this issue.

closes odoo/documentation#2829

X-original-commit: 9ed3575f19
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Stockbauer Matthieu (tsm) <tsm@odoo.com>
2022-10-20 17:17:12 +02:00
Olivier Dony 9d9548da4a [IMP] legal: make PDF links relative
This way we don't need to update the links nor risk a desynchronization
between the version of the PDF and the HTML.

Previously version 15.0 and 16.0 still referenced the 14.0 PDFs
(which are the same at the moment, but still...)
2022-10-19 19:11:49 +02:00
Olivier Dony c1bc6ddf6e [FIX] legal: enterprise terms FR fall 2022 pricing typo 2022-10-19 19:11:45 +02:00
“Friederike f42bf525e9 [FIX] legal: enterprise terms DE translation update (v9c) 2022-10-19 19:11:41 +02:00
Elias ade054b752 [FIX] developer/howtos/rdtraining: Update warning message
Update warning output for missing access rules.
Also reflect up-to-date contents of res.country.state.csv.

closes odoo/documentation#2826

X-original-commit: e21dbd01c9
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-18 13:17:37 +02:00
Victor Feyens 9a5b5b0614 [FIX] *: Odoo 16 requires postgresql 12
Update the minimal version in the installation doc
Make all postgresql docs references target the v12 documentation
Fix some non http links on the way

closes odoo/documentation#2822

X-original-commit: 93b383e95d
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-18 12:19:30 +02:00
Olivier Dony 4fe6fbee12 [CHG] legal: enterprise terms for fall 2022 pricing
- removal of "per app" notion
- addition of "subscription plan" notion
2022-10-13 12:20:27 +02:00
Antoine Vandevenne (anv) cd549cb386 [IMP] supported_version: release 16.0 and deprecate 13.0
closes odoo/documentation#2814

X-original-commit: 3c61d24b1d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-12 09:39:45 +02:00
Demesmaeker d41a66758f [IMP] sale_amazon: support all marketplaces
task-2939972

closes odoo/documentation#2806

X-original-commit: 91f3859a53
Related: odoo/enterprise#32699
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-11 16:57:18 +02:00
Victor Feyens 3a7be7730d [IMP] developer/orm: environment documentation
Move Environment explanation to the class docstring and autogenerate the
doc

Add documentation on some util methods.

closes odoo/documentation#2803

X-original-commit: 7c42ab8eaf
Related: odoo/odoo#102969
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-10 19:55:40 +02:00
Victor Feyens c8ab0c1535 [FIX] developer/iap: wrong :class: element
X-original-commit: b7f5b3e04b
Part-of: odoo/documentation#2803
2022-10-10 19:55:40 +02:00
Antoine Vandevenne (anv) 0e567a08de [IMP] reference/payment: auto-document the method _get_removal_values
Task - 3002532

closes odoo/documentation#2802

X-original-commit: 7696235acb
Related: odoo/odoo#102951
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-10 19:03:20 +02:00
Antoine Vandevenne (anv) 9baab389c9 [ADD] reference/standard_modules: API reference for the payment engine
task-2804999

closes odoo/documentation#2797

X-original-commit: 668ac2c650
Related: odoo/odoo#102716
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-09 09:11:46 +02:00
Xavier-Do 46a80f60c5 [ADD] developer/reference: add a reference page on performance
closes odoo/documentation#2794

X-original-commit: 4d8e3f9785
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Xavier Dollé (xdo) <xdo@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-06 18:01:00 +02:00
Julien Van Roy aab2d6615a [IMP] accounting/electronic_invoicing: update factur-x usage
Update Factur-X mentions and screenshot.

task-2957808
https://github.com/odoo/odoo/pull/99699

closes odoo/documentation#2789

X-original-commit: 1387c5e8c3
Related: odoo/odoo#102311
Related: odoo/enterprise#32344
Signed-off-by: Julien Van Roy <juvr@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-10-06 10:43:01 +02:00
Denis Ledoux 991b8142fe [IMP] developer/reference: move model view related methods out of orm
The model method `get_views` and `get_view` are moved
from `odoo/models.py` to `odoo/addons/base/models/ir_ui_view.py`.

The documentation is updated accordingly,
to put the documentation related to `get_views` in the
views chapter of the documentation.

closes odoo/documentation#2786

X-original-commit: 0bdf714112
Related: odoo/odoo#102117
Signed-off-by: Denis Ledoux (dle) <dle@odoo.com>
2022-10-04 18:06:37 +02:00
Aleksander f4bbbcb6c1 [FW][IMP] howtos/rdtraining: give the meaning of "ACL"
closes odoo/documentation#2779

Forward-port-of: odoo/documentation#2774
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-30 12:34:44 +02:00
Jonathan Quique (jqu) 768ab1b586 [IMP] email_communication: can't use Odoo STMP with another mail server
Customer may want to use their own SMTP for email marketing, and Odoo default SMTP for everything else. There is no good way to do this. Previously we suggested adding Odoo SMTP as an outgoing email server but we don't want to share credentials anymore.
R&D is working on a solution (e.g. showing the Odoo default email server in the list rather than keeping it as an "hidden feature") but for the time being, if you use an outgoing email server, you give up using the Odoo default SMTP.

closes odoo/documentation#2771

X-original-commit: 7b21e6001b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-29 14:23:59 +02:00
Jonathan Castillo (jcs) 7424e4176c [IMP] website: register domain name menu path
closes odoo/documentation#2766

X-original-commit: 81352e98b2
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-09-28 00:20:45 +02:00
Wesley Kao (weka) 8287c88bd4 [IMP] MRP: updated Variants BOM Management rst content
closes odoo/documentation#2764

X-original-commit: b3d5e928aa
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-27 19:14:46 +02:00
Xavier-Do 53e7277b6a [FIX]: fix odoo_version detection
Right now if the version is not "final (and not alpha)"
documentation will say 16.0beta != 16.0

closes odoo/documentation#2748

X-original-commit: 406f3aac18
Signed-off-by: Xavier Dollé (xdo) <xdo@odoo.com>
2022-09-26 09:35:48 +02:00
Fabrice Henrion 2c7d61f938 [FIX] accounting: grammar fix in ponto
closes odoo/documentation#2759

X-original-commit: dad110c7cc
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-09-23 11:22:40 +02:00
950 changed files with 11470 additions and 7560 deletions
+1 -1
View File
@@ -60,4 +60,4 @@ source_lang = en
[odoo-14-doc.websites]
file_filter = locale/<lang>/LC_MESSAGES/websites.po
source_file = locale/sources/websites.pot
source_lang = en
source_lang = en
+1 -1
View File
@@ -55,7 +55,7 @@ html: $(HTML_BUILD_DIR)/_static/style.css
# To call *after* `make html`
# Binary dependencies (Debian): texlive-fonts-recommended texlive-latex-extra
# texlive-generic-recommended texlive-fonts-extra
# texlive-fonts-extra
latexpdf:
@echo "Starting build..."
$(SPHINX_BUILD) -c $(CONFIG_DIR) -b latex $(SPHINXOPTS) $(SOURCE_DIR) $(BUILD_DIR)/latex
+13 -23
View File
@@ -4,43 +4,33 @@
### Requirements
- [Git](https://www.odoo.com/documentation/master/contributing/documentation.html#install-git)
- [Python 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
- Python 3.6, 3.7, or 3.8
- Python dependencies listed in the file `requirements.txt`.
- Make
- A local copy of the [odoo/odoo repository](https://github.com/odoo/odoo) (optional)
### Instructions
1. In a terminal, navigate to the root directory and compile the documentation to HTML with the
following command:
```sh
make
```
1. In a terminal, navigate to the root directory of the documentation and build it `make`.
Additional commands are available with `make help`.
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)
2. Open the file `documentation/_build/html/index.html` in your web browser.
3. See [this guide](https://www.odoo.com/documentation/latest/contributing/documentation.html)
for more detailed instructions.
Optional: to fully build the developer documentation with inline docstrings for documented Python
functions, place your local copy of the `odoo/odoo` repository in the root directory. Alternatively,
create a symbolic link with `odoo` as link name. If the Odoo sources are not found, a warning will
be shown.
Optional: place your local copy of the `odoo/odoo` repository in the parent directory or in the root
directory of the documentation to build the latter with the documented Python docstrings.
## 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/latest/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.
[repository's issue tracker](https://github.com/odoo/documentation/issues).
## Learn More
To learn more about Odoo, in addition to the documentation, have a look at
[the official eLearning](https://odoo.com/slides) and
[Scale-up, The Business Game](https://www.odoo.com/page/scale-up-business-game).
[Scale-up, The Business Game](https://www.odoo.com/page/scale-up-business-game).
+1 -1
View File
@@ -16,4 +16,4 @@
# [REM] = Removal
# [REF] = Refactoring (restructuring)
# [MOV] = Move/rename
#
#
+32 -7
View File
@@ -1,14 +1,14 @@
import re
import os
import re
import shutil
import sys
from pathlib import Path
import docutils
import sphinx
from pygments.lexers import JsonLexer, XmlLexer
from sphinx.ext import graphviz
from sphinx.util import logging
import sphinx
_logger = logging.getLogger(__name__)
@@ -19,11 +19,25 @@ _logger = logging.getLogger(__name__)
project = 'Odoo'
copyright = 'Odoo S.A.'
# `version` if the version info for the project being documented, acts as replacement for |version|,
# `version` is 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'
# `current_branch` is the technical name of the current branch.
# E.g., saas-15.4 -> saas-15.4; 12.0 -> 12.0, master -> master (*).
current_branch = version
# `current_version` is the Odoo version linked to the current branch.
# E.g., saas-15.4 -> 15.4; 12.0 -> 12; master -> master (*).
current_version = current_branch.replace('saas-', '').replace('.0', '')
# `current_major_branch` is the technical name of the major branch before the current branch.
# E.g., saas-15.4 -> 15.0; 12.0 -> 12.0; master -> master (*).
current_major_branch = re.sub(r'\.\d', '.0', current_branch.replace('saas-', ''))
# `current_major_version` is the Odoo version linked to the current major branch.
# E.g., saas-15.4 -> 15; 12.0 -> 12; master -> master (*).
current_major_version = current_major_branch.replace('.0', '')
# (*): We don't care for master.
# The minimal Sphinx version required to build the documentation.
needs_sphinx = '3.0.0'
@@ -61,8 +75,14 @@ add_function_parentheses = True
#=== Extensions configuration ===#
source_read_replace_vals = {
'BRANCH': current_branch,
'CURRENT_BRANCH': current_branch,
'CURRENT_VERSION': current_version,
'CURRENT_MAJOR_BRANCH': current_major_branch,
'CURRENT_MAJOR_VERSION': current_major_version,
'GITHUB_PATH': f'https://github.com/odoo/odoo/blob/{version}',
'GITHUB_ENT_PATH': f'https://github.com/odoo/enterprise/blob/{version}',
'OWL_PATH': f'https://github.com/odoo/owl/blob/master',
}
# Add extensions directory to PYTHONPATH
@@ -95,7 +115,7 @@ else:
import odoo.addons
odoo.addons.__path__.append(str(odoo_dir) + '/addons')
from odoo import release as odoo_release # Don't collide with Sphinx's 'release' config option
odoo_version = odoo_release.version.replace('~', '-') # Change saas~XX.Y to saas-XX.Y
odoo_version = '.'.join(str(s) for s in odoo_release.version_info[:2]).replace('~', '-') # Change saas~XX.Y to saas-XX.Y
odoo_version = 'master' if 'alpha' in odoo_release.version else odoo_version
if release != odoo_version:
_logger.warning(
@@ -145,6 +165,9 @@ extensions = [
# Content tabs
'sphinx_tabs.tabs',
# Spoilers
'spoilers',
# Strange html domain logic used in memento pages
'html_domain',
]
@@ -187,6 +210,8 @@ sphinx.transforms.i18n.docname_to_domain = (
# is populated. If a version is passed to `versions` but is not listed here, it will not be shown.
versions_names = {
'master': "Master",
'16.0': "Odoo 16",
'saas-15.3': "Odoo Online",
'saas-15.2': "Odoo Online",
'15.0': "Odoo 15",
'14.0': "Odoo 14",
@@ -274,7 +299,7 @@ latex_documents = [
('legal/terms/i18n/partnership_tex_fr',
'odoo_partnership_agreement_fr.tex', 'Odoo Partnership Agreement (FR)', '', 'howto'),
('legal/terms/i18n/terms_of_sale_fr', 'terms_of_sale_fr.tex',
u'Conditions Générales de Vente Odoo', '', 'howto'),
'Conditions Générales de Vente Odoo', '', 'howto'),
('legal/terms/i18n/enterprise_tex_nl', 'odoo_enterprise_agreement_nl.tex',
'Odoo Enterprise Subscription Agreement (NL)', '', 'howto'),
@@ -310,7 +335,6 @@ def source_read_replace(app, docname, source):
result = result.replace(f"{{{key}}}", app.config.source_read_replace_vals[key])
source[0] = result
def setup(app):
# Generate all alternate URLs for each document
app.add_config_value('project_root', None, 'env')
@@ -398,8 +422,9 @@ def _generate_alternate_urls(app, pagename, templatename, context, doctree):
The entry 'language' is added by Sphinx in the rendering context.
"""
_current_lang = app.config.language or 'en'
# Replace the context value by its translated description ("Français" instead of "french")
# Replace the context value by its upper-cased value ("FR" instead of "fr")
context['language'] = languages_names.get(_current_lang)
context['language_code'] = _current_lang
# If the list of languages is not set, assume that the project has no alternate language
_provided_languages = app.config.languages and app.config.languages.split(',') or []
+31 -37
View File
@@ -97,7 +97,7 @@ Configuration sample
* Allow tcp connection on localhost
* Allow tcp connection from 192.168.1.x network
in ``/etc/postgresql/9.5/main/pg_hba.conf`` set:
in ``/etc/postgresql/<YOUR POSTGRESQL VERSION>/main/pg_hba.conf`` set:
.. code-block:: text
@@ -105,7 +105,7 @@ in ``/etc/postgresql/9.5/main/pg_hba.conf`` set:
host all all 127.0.0.1/32 md5
host all all 192.168.1.0/24 md5
in ``/etc/postgresql/9.5/main/postgresql.conf`` set:
in ``/etc/postgresql/<YOUR POSTGRESQL VERSION>/main/postgresql.conf`` set:
.. code-block:: text
@@ -172,7 +172,7 @@ in Odoo the db_sslmode control the ssl security of the connection
with value chosen out of 'disable', 'allow', 'prefer', 'require', 'verify-ca'
or 'verify-full'
`PostgreSQL Doc <https://www.postgresql.org/docs/current/static/libpq-ssl.html>`_
`PostgreSQL Doc <https://www.postgresql.org/docs/12/static/libpq-ssl.html>`_
.. _builtin_server:
@@ -290,6 +290,10 @@ in ``/etc/nginx/sites-enabled/odoo.conf`` set:
upstream odoochat {
server 127.0.0.1:8072;
}
map $http_upgrade $connection_upgrade {
default upgrade;
'' close;
}
# http -> https
server {
@@ -388,7 +392,7 @@ The solutions to support livechat/motifications in a WSGI application are:
* Deploy a threaded version of Odoo (instead of a process-based preforking
one) and redirect only requests to URLs starting with ``/websocket/`` to
that Odoo, this is the simplest and the websocket URL can double up as the cron
that Odoo, this is the simplest and the websocket URL can double up as the cron
instance.
* Deploy an evented Odoo via ``odoo-gevent`` and proxy requests starting
with ``/websocket/`` to
@@ -406,21 +410,23 @@ a static HTTP server.
Serving static files
--------------------
Odoo static files are located in each module's :file:`static/` folder, so static files can be served
Odoo static files are located in each module's :file:`static/` folder, so static files can be served
by intercepting all requests to :samp:`/{MODULE}/static/{FILE}`, and looking up the right module
(and file) in the various addons paths.
.. example::
Say Odoo has been installed via the **debian packages** for Community and Enterprise, the addons
paths is :file:`/usr/lib/python3/dist-packages/odoo/addons`. Using the above NGINX (https)
configuration, the following location block should be added to serve static files via NGINX.
Say Odoo has been installed via the **debian packages** for Community and Enterprise and the
:option:`--addons-path <odoo-bin --addons-path>` is ``'/usr/lib/python3/dist-packages/odoo/addons'``.
Using the above NGINX (https) configuration, the following location block should be added to
serve static files via NGINX.
.. code-block:: nginx
location @odoo {
# copy-paste the content of the / location block
}
# Serve static files right away
location ~ ^/[^/]+/static/.+$ {
root /usr/lib/python3/dist-packages/odoo/addons;
@@ -429,38 +435,26 @@ by intercepting all requests to :samp:`/{MODULE}/static/{FILE}`, and looking up
}
.. example::
Say Odoo has been installed via the **source**, and the two git repositories for Community and
Enterprise has been cloned in :file:`/opt/odoo` and :file:`/opt/odoo-enterprise` respectively.
The addons paths is ``/opt/odoo/odoo,/opt/odoo/addons,/opt/odoo-enterprise``. Using the above
NGINX (https) configuragion, the following location block should be added to serve static files
via NGINX.
Say Odoo has been installed via the **source**. The two git repositories for Community and
Enterprise have been cloned in :file:`/opt/odoo/community` and :file:`/opt/odoo/enterprise`
respectively and the :option:`--addons-path <odoo-bin --addons-path>` is
``'/opt/odoo/community/odoo/addons,/opt/community/addons,/opt/odoo/enterprise'``.
Using the above NGINX (https) configuration, the following location block should be added to
serve static files via NGINX.
.. code-block:: nginx
location @odoo {
# copy-paste the content of the / location block
}
# Serve static files right away
location ~ ^/[^/]+/static/.+$ {
try_files /static-base$uri /static-addons$uri /static-enterprise$uri @odoo$uri;
root /opt/odoo;
try_files /community/odoo/addons$uri /community/addons$uri /enterprise$uri @odoo;
expires 24h;
}
location /static-base {
internal;
alias /opt/odoo/odoo/addons;
}
location /static-addons {
internal;
alias /opt/odoo/addons;
}
location /static-enterprise {
internal;
alias /opt/odoo-enterprise;
}
.. warning::
The actual NGINX configuration you need is highly dependent on your own installation. The two
@@ -489,7 +483,7 @@ X-Sendfile and X-Accel).
- The X-Accel extension for NGINX **does** require the following additionnal configuration:
.. code-block:: nginx
location /web/filestore {
internal;
alias /path/to/odoo/data-dir/filestore;
@@ -741,8 +735,8 @@ Here are the supported browsers:
.. _socat: http://www.dest-unreach.org/socat/
.. _PostgreSQL connection settings:
.. _listen to network interfaces:
https://www.postgresql.org/docs/9.6/static/runtime-config-connection.html
https://www.postgresql.org/docs/12/static/runtime-config-connection.html
.. _use an SSH tunnel:
https://www.postgresql.org/docs/9.6/static/ssh-tunnels.html
https://www.postgresql.org/docs/12/static/ssh-tunnels.html
.. _WSGI: https://wsgi.readthedocs.org/
.. _POSBox: https://www.odoo.com/page/point-of-sale-hardware#part_2
+28 -29
View File
@@ -33,7 +33,7 @@ Editions
========
There are two different Editions_ of Odoo: the Community and Enterprise versions.
Using the Enterprise version is possible on our SaaS_ and accessing the code is
Using the Enterprise version is possible on `Odoo Online`_ and accessing the code is
restricted to Enterprise customers and partners. The Community version is freely
available to anyone.
@@ -55,17 +55,17 @@ around and try things out with no commitment.
Demo_ instances require no local installation, just a web browser.
SaaS
----
Odoo Online
-----------
Trivial to start with, fully managed and migrated by Odoo S.A., Odoo's SaaS_
Trivial to start with, fully managed and migrated by Odoo S.A., `Odoo Online`_
provides private instances and starts out free. It can be used to discover and
test Odoo and do non-code customizations (i.e. incompatible with custom modules
or the Odoo Apps Store) without having to install it locally.
Can be used for both testing Odoo and long-term production use.
Like demo_ instances, SaaS_ instances require no local installation, a web
Like demo_ instances, `Odoo Online`_ instances require no local installation, a web
browser is sufficient.
@@ -146,13 +146,13 @@ Repository
.. group-tab:: Debian/Ubuntu
Odoo S.A. provides a repository that can be used with Debian and Ubuntu distributions. It can
be used to install *Odoo Community Edition* by executing the following commands **as root**:
be used to install *Odoo Community Edition* by executing the following commands:
.. code-block:: console
# wget -O - https://nightly.odoo.com/odoo.key | apt-key add -
# echo "deb http://nightly.odoo.com/15.0/nightly/deb/ ./" >> /etc/apt/sources.list.d/odoo.list
# apt-get update && apt-get install odoo
$ wget -q -O - https://nightly.odoo.com/odoo.key | sudo gpg --dearmor -o /usr/share/keyrings/odoo-archive-keyring.gpg
$ echo 'deb [signed-by=/usr/share/keyrings/odoo-archive-keyring.gpg] https://nightly.odoo.com/{CURRENT_MAJOR_BRANCH}/nightly/deb/ ./' | sudo tee /etc/apt/sources.list.d/odoo.list
$ sudo apt-get update && sudo apt-get install odoo
You can then use the usual `apt-get upgrade` command to keep your installation up-to-date.
@@ -163,7 +163,7 @@ Repository
.. code-block:: console
$ sudo dnf config-manager --add-repo=https://nightly.odoo.com/15.0/nightly/rpm/odoo.repo
$ sudo dnf config-manager --add-repo=https://nightly.odoo.com/{CURRENT_MAJOR_BRANCH}/nightly/rpm/odoo.repo
$ sudo dnf install -y odoo
$ sudo systemctl enable odoo
$ sudo systemctl start odoo
@@ -183,8 +183,8 @@ Distribution package
<download_>`_.
.. note::
Odoo 15.0 'deb' package currently supports `Debian 11 (Bullseye)`_, `Ubuntu 20.04 (Focal)`_
or above.
Odoo {CURRENT_MAJOR_VERSION} 'deb' package currently supports `Debian 11 (Bullseye)`_,
`Ubuntu 22.04 (Jammy)`_ or above.
Next, execute the following commands **as root**:
@@ -224,13 +224,13 @@ Distribution package
<download_>`_.
.. note::
Odoo 15.0 'rpm' package supports Fedora 34.
Odoo {CURRENT_MAJOR_VERSION} 'rpm' package supports Fedora 36.
Once downloaded, the package can be installed using the 'dnf' package manager:
.. code-block:: console
$ sudo dnf localinstall odoo_15.0.latest.noarch.rpm
$ sudo dnf localinstall odoo_{CURRENT_MAJOR_BRANCH}.latest.noarch.rpm
$ sudo systemctl enable odoo
$ sudo systemctl start odoo
@@ -242,9 +242,8 @@ Source install
The source "installation" is really about not installing Odoo, and running it directly from source
instead.
This can be more convenient for module developers as the Odoo source is more easily accessible
than using packaged installation (for information or to build this documentation and have it
available offline).
It can be more convenient for module developers as the Odoo source is more easily accessible than
using packaged installation.
It also makes starting and stopping Odoo more flexible and explicit than the services set up by the
packaged installations, and allows overriding settings using
@@ -432,7 +431,7 @@ PostgreSQL
.. group-tab:: Windows
Odoo uses PostgreSQL as database management system. `Download and install PostgreSQL
<https://www.postgresql.org/download/windows/>`_ (supported version: 10.0 and later).
<https://www.postgresql.org/download/windows/>`_ (supported version: 12.0 and later).
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need
to create a new PostgreSQL user:
@@ -452,7 +451,7 @@ PostgreSQL
.. group-tab:: Linux
Odoo uses PostgreSQL as database management system. Use your package manager to download and
install PostgreSQL (supported version: 10.0 and later).
install PostgreSQL (supported version: 12.0 and later).
It can be achieved by executing the following:
@@ -475,7 +474,7 @@ PostgreSQL
.. group-tab:: Mac OS
Odoo uses PostgreSQL as database management system. Use `postgres.app
<https://postgresapp.com>`_ to download and install PostgreSQL (supported version: 10.0 and
<https://postgresapp.com>`_ to download and install PostgreSQL (supported version: 12.0 and
later).
.. tip::
@@ -547,7 +546,7 @@ Dependencies
.. tab:: Debian/Ubuntu
For Debian-based systems, the packages are listed in the `debian/control
<https://github.com/odoo/odoo/blob/master/debian/control>`_ file of the Odoo sources.
<{GITHUB_PATH}/debian/control>`_ file of the Odoo sources.
On Debian/Ubuntu, the following commands should install the required packages:
@@ -726,24 +725,24 @@ official Odoo `docker image <https://hub.docker.com/_/odoo/>`_ page.
.. _demo: https://demo.odoo.com
.. _docker: https://www.docker.com
.. _download: https://www.odoo.com/page/download
.. _Ubuntu 20.04 (Focal): http://releases.ubuntu.com/20.04/
.. _Ubuntu 22.04 (Jammy): https://releases.ubuntu.com/22.04/
.. _EPEL: https://fedoraproject.org/wiki/EPEL
.. _PostgreSQL: http://www.postgresql.org
.. _PostgreSQL: https://www.postgresql.org
.. _the official installer:
.. _install pip:
https://pip.pypa.io/en/latest/installing.html#install-pip
.. _Quilt: http://en.wikipedia.org/wiki/Quilt_(software)
.. _saas: https://www.odoo.com/page/start
.. _Quilt: https://en.wikipedia.org/wiki/Quilt_(software)
.. _Odoo Online: https://www.odoo.com/page/start
.. _the wkhtmltopdf download page: https://github.com/wkhtmltopdf/wkhtmltopdf/releases/tag/0.12.5
.. _UAC: http://en.wikipedia.org/wiki/User_Account_Control
.. _wkhtmltopdf: http://wkhtmltopdf.org
.. _UAC: https://en.wikipedia.org/wiki/User_Account_Control
.. _wkhtmltopdf: https://wkhtmltopdf.org
.. _pip: https://pip.pypa.io
.. _macports: https://www.macports.org
.. _homebrew: http://brew.sh
.. _homebrew: https://brew.sh
.. _wheels: https://wheel.readthedocs.org/en/latest/
.. _virtualenv: https://pypi.python.org/pypi/virtualenv
.. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/latest/
.. _pywin32: http://sourceforge.net/projects/pywin32/files/pywin32/
.. _pywin32: https://sourceforge.net/projects/pywin32/files/pywin32/
.. _community-repository: https://github.com/odoo/odoo
.. _enterprise-repository: https://github.com/odoo/enterprise
.. _Editions: https://www.odoo.com/pricing#pricing_table_features
+2 -1
View File
@@ -8,9 +8,10 @@ Maintain
maintain/domain_names
maintain/google_oauth
maintain/mailjet_api
maintain/update
maintain/enterprise
maintain/hosting_changes
maintain/online
maintain/odoo_online
maintain/on_premise
maintain/supported_versions
@@ -17,7 +17,7 @@ You can use a custom domain name to access your Odoo database and websites:
``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
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``.
@@ -62,11 +62,11 @@ database manager.
- This offer doesn't include any mailbox. However, you can :ref:`configure your MX records
<domain-name/odoo-manage>` to use your own email server or solution such as Google Workspace.
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
:guilabel:`settings` button next to your database, then on :guilabel:`Domain names`.
To do so, go to :menuselection:`Website --> Domain Name`. Alternatively, open your `database manager
<https://www.odoo.com/my/databases>`_, click on the :guilabel:`settings` button next to your
database, then on :guilabel:`Domain names`.
.. image:: domain_names/register-promote.png
.. image:: domain_names/register-menu.png
:align: center
:alt: Clicking on Domain Names from an Odoo website
@@ -125,8 +125,8 @@ that you proceed with the following actions in this order:
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.
A **CNAME record** is a type of DNS record that points to the domain of another website rather than
directly to an IP address.
You need a CNAME record that points to your Odoo database. The requirements are detailed in your
database manager.
@@ -151,7 +151,7 @@ database manager.
#. 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
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``).
Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 38 KiB

@@ -41,7 +41,7 @@ On Linux, using an installer
.. code-block:: console
$ sudo dpkg -i <path_to_enterprise_deb>
* Update your database to the enterprise packages using
.. code-block:: console
@@ -123,7 +123,7 @@ server in Odoo. The configuration automatically loads the token in Odoo, and a t
:align: center
:alt: Configure Outgoing Email Servers in Odoo.
Finally, save the settings and :guilabel:`Test the Connection`. A confirmation message should
Finally, save the settings and :guilabel:`Test the Connection`. A confirmation message should
appear. The Odoo database can now send safe, secure emails through Google using OAuth
authentication.
@@ -85,4 +85,3 @@ From Odoo.sh to on-premises
1. Grab a :ref:`backup of your Odoo.sh production database <odoo_sh_branches_backups>`.
2. Restore it from the database manager on your local server.
@@ -0,0 +1,218 @@
===========
Mailjet API
===========
Odoo is compatible with Mailjet's :abbr:`API (Application Programming Interface)` for mass mailing.
Set up a dedicated mass mailing server through Mailjet by configuring settings in the Mailjet
account and the Odoo database. In some circumstances, settings need to be configured on the custom
domain's :abbr:`DNS (Domain Name System)` settings as well.
Set up in Mailjet
=================
Create API credentials
----------------------
To get started, sign in to the `Mailjet Account Information <https://app.mailjet.com/account>`_
page. Next, navigate to the :guilabel:`Senders & Domains` section and click on :guilabel:`SMTP and
SEND API Settings`.
.. image:: mailjet_api/api-settings.png
:align: center
:alt: SMTP and Send API Settings link in the Senders & Domains section of Mailjet.
Then, copy the :abbr:`SMTP (Simple Mail Transfer Protocol)` configuration settings onto a notepad.
They can be found under the :guilabel:`Configuration (SMTP only)` section. The :abbr:`SMTP (Simple
Mail Transfer Protocol)` configuration settings include the server address, the security option
needed (Use :abbr:`SSL (Secure Sockets Layer)`/:abbr:`TLS (Transport Layer Security)`), and the
port number. The settings are needed to configure Mailjet in Odoo, which is covered in the
:ref:`last section <maintain/mailjet-api/odoo-setup>`.
.. seealso::
`Mailjet: How can I configure my SMTP parameters?
<https://documentation.mailjet.com/hc/articles/360043229473>`_
.. important::
Odoo blocks `port 25` on Odoo Online and Odoo.sh databases. :ref:`See reference here
<email_servers/restriction>`.
.. image:: mailjet_api/smtp-config.png
:align: center
:alt: SMTP configuration from Mailjet.
Next, click on the button labeled :guilabel:`Retrieve your API credentials` to retrieve the Mailjet
API credentials.
Then, click on the eye icon to reveal the :guilabel:`API key`. Copy this key to a notepad, as this
serves as the :guilabel:`Username` in the Odoo configuration. Next, click on the
:guilabel:`Generate Secret Key` button to generate the :guilabel:`Secret Key`. Copy this key to a
notepad, as this serves as the :guilabel:`Password` in the Odoo configuration.
Add verified sender address(es)
-------------------------------
The next step is to add a sender address or a domain to the Mailjet account settings so that the
email address or domain is approved to send emails using Mailjet's servers. First, navigate to the
`Mailjet Account Information <https://app.mailjet.com/account>`_ page. Next, click on the
:guilabel:`Add a Sender Domain or Address` link under the :guilabel:`Senders & Domains` section.
.. image:: mailjet_api/add-domain-email.png
:align: center
:alt: Add a sender domain or address in the Mailjet interface.
Determine if a sender's email address or the entire domain needs to be added to the Mailjet
settings. It may be easier to configure the domain as a whole if :abbr:`DNS (Domain Name System)`
access is available. Jump to the :ref:`Add a domain <maintain/mailjet-api/add-domain>` section for
steps on adding the domain.
.. note::
Either all email addresses of the Odoo database users who are sending emails using Mailjet's
servers need to be configured or the domain(s) of the users' email addresses can be configured.
By default, the email address originally set up in the Mailjet account is added as a trusted
sender. To add another email address, click on the button labeled :guilabel:`Add a sender address`.
Then, add the email address that is configured to send from the custom domain.
At minimum the following email addresses should be set up in the provider and verified in Mailjet:
- notifications\@yourdomain.com
- bounce\@yourdomain.com
- catchall\@yourdomain.com
.. note::
Replace `yourdomain` with the custom domain for the Odoo database. If there isn't one, then use
the :guilabel:`mail.catchall.domain` system parameter.
After that, fill out the :guilabel:`Email Information` form, making sure to select the appropriate
email type: transactional email or mass emails. After completing the form, an activation email is
sent to the email address and the trusted sender can be activated.
It is recommended to set up the :abbr:`SPF (Sender Policy Framework)`/:abbr:`DKIM (DomainKeys
Identified Mail)`/:abbr:`DMARC (Domain-based Message Authentication, Reporting, and
Conformance)` settings on the domain of the sender.
.. seealso::
`Mailjet's SPF/DKIM/DMARC documentation <https://documentation.mailjet.com/hc/articles/
360042412734-Authenticating-Domains-with-SPF-DKIM>`_
.. important::
If the database is not using a custom domain, then in order to verify the sender's address, a
temporary alias (of the three email addresses mentioned above) should be set up in Odoo CRM to
create a lead. Then, the database is able to receive the verification email and verify the
accounts.
.. _maintain/mailjet-api/add-domain:
Add a domain
------------
By adding an entire domain to the Mailjet account, all the sender addresses related to that domain
are automatically validated for sending emails using Mailjet servers. First, navigate to the
`Mailjet Account Information <https://app.mailjet.com/account>`_ page. Next, click on
:guilabel:`Add a Sender Domain or Address` link under the :guilabel:`Senders & Domains` section.
Then, click on :guilabel:`Add domain` to add the custom domain.
.. note::
The domain needs to be added to the Mailjet account and then validated through the :abbr:`DNS
(Domain Name System)`.
After that, fill out the :guilabel:`Add a new Domain` page on Mailjet and click
:guilabel:`Continue`.
After adding the domain, a validation page will populate. Unless the Odoo database is on-premise
(in which case, choose :guilabel:`Option 1`), choose :guilabel:`Option 2: Create a DNS Record`.
Copy the TXT record information to a notepad and then navigate to the domain's :abbr:`DNS (Domain
Name System)` provider to complete validation.
.. image:: mailjet_api/host-value-dns.png
:align: center
:alt: The TXT record information to input on the domain's DNS.
Setup in the domain's DNS
~~~~~~~~~~~~~~~~~~~~~~~~~
After getting the TXT record information from the Mailjet account, add a TXT record to the domain's
:abbr:`DNS (Domain Name System)`. This process varies depending on the :abbr:`DNS (Domain Name
System)` provider. Consult the provider for specific configuration processes. The TXT record
information consists of the :guilabel:`Host` and :guilabel:`Value`. Paste these into
the corresponding fields in the TXT record.
Return to Mailjet account information
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
After adding the TXT record to the domain's :abbr:`DNS (Domain Name System)`, navigate back to the
Mailjet account. Then, navigate to :menuselection:`Account Information --> Add a Sender Domain or
Address`, click the gear icon next to :guilabel:`Domain`, and select :guilabel:`Validate`.
This action can also be done by going to the `Sender domains & addresses <https://app.mailjet.com/
account/sender>`_ page on the Mailjet account information and clicking on :guilabel:`Manage`.
Next, click :guilabel:`Check Now` to validate the TXT record that was added on the domain. A
success screen will appear if the domain is configured correctly.
.. image:: mailjet_api/check-dns.png
:align: center
:alt: Check DNS record in Mailjet.
After successfully setting up the domain, there is an option to :guilabel:`Authenticate this domain
(SPF/DKIM)`. This button populates :abbr:`SPF (Sender Policy Framework)` & :abbr:`DKIM (DomainKeys
Identified Mail) records to input into the :abbr:`DNS (Domain Name System)` provider.
.. seealso::
`Mailjet's SPF/DKIM/DMARC documentation <https://documentation.mailjet.com/hc/articles/
360042412734-Authenticating-Domains-with-SPF-DKIM>`_
.. image:: mailjet_api/authenticate.png
:align: center
:alt: Authenticate the domain with SPF/DKIM records in Mailjet.
.. _maintain/mailjet-api/odoo-setup:
Set up in Odoo
==============
To complete the setup, navigate to the Odoo database and go to the :guilabel:`Settings`. With
:ref:`developer-mode` turned on, go to the :menuselection:`Technical Menu --> Email --> Outgoing
Mail Servers`. Then, create a new outgoing server configuration by clicking on the
:guilabel:`Create` button.
Next, input the `SMTP server` (in-v3.mailjet.com), `port number` (587 or 465), and `Security
(SSL/TLS)` that was copied earlier from the Mailjet account. They can also be found `here
<https://app.mailjet.com/account/setup>`_. It is recommended to use :abbr:`SSL (Secure Sockets
Layer)`/:abbr:`TLS (Transport Layer Security)` even though Mailjet may not require it.
For the :guilabel:`Username`, input the :guilabel:`API KEY`. For the :guilabel:`Password`, input
the :guilabel:`SECRET KEY` that was copied from the Mailjet account to the notepad earlier. These
settings can be found on :menuselection:`Mailjet --> Account Settings --> SMTP and SEND API
Settings`.
Then, if the Mailjet server is used for mass emailing, set the :guilabel:`Priority` value higher
than that of any transactional email server(s). Finally, save the settings and :guilabel:`Test the
Connection`.
.. image:: mailjet_api/server-settings.png
:align: center
:alt: Odoo outgoing email server settings.
.. important::
In order for the notifications feature to work using Mailjet, there are three settings that need
to be set in Odoo.
#. The :guilabel:`From Filter` needs to be set on the server configuration. It is recommended
to set it as a domain and not a full email address. It should match the domain in the two
proceeding steps. More information can be referenced :ref:`here
<email_servers/outgoing-email-server>`.
#. The :guilabel:`mail.default.from` system parameter must have the value
`notifications\@yourdomain.com`.
#. The :guilabel:`mail.default.from_filter` system parameter must have the value
`yourdomain.com`. Replace `yourdomain` with the custom domain for the Odoo database. If there
isn't one, then use the :guilabel:`mail.catchall.domain` system parameter.
For more information see :ref:`Using a default email address <email_domain/default>`.
The :guilabel:`System Parameters` can be accessed by activating
:doc:`../../applications/general/developer_mode` in the :menuselection:`Settings --> Technical
--> Parameters --> System Parameters` menu.
Once the setup is complete, the Odoo database is ready to use the Mailjet email server for mass
mailing or transactional emails!
Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

@@ -1,18 +1,18 @@
=================================
Online (SaaS) database management
=================================
===============================
Odoo Online 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
.. image:: odoo_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
.. image:: odoo_online/dropdown-menu.png
:align: right
:alt: Clicking on the gear icon opens the drop-down menu.
@@ -20,17 +20,17 @@ Open the drop-down menu next to the database you want to manage by clicking on t
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`
- :ref:`odoo_online/upgrade`
- :ref:`odoo_online/duplicate`
- :ref:`odoo_online/rename`
- :ref:`odoo_online/download`
- :ref:`odoo_online/domains`
- :ref:`odoo_online/tags`
- :ref:`odoo_online/delete`
- :ref:`odoo_online/contact-support`
- :ref:`odoo_online/users`
.. _online/upgrade:
.. _odoo_online/upgrade:
Upgrade
=======
@@ -56,7 +56,7 @@ upgrade to the latest version (e.g., 13.0 to 15.1).
- :doc:`../upgrade`
- :doc:`supported_versions`
.. _online/duplicate:
.. _odoo_online/duplicate:
Duplicate
=========
@@ -69,14 +69,14 @@ operations.
orders, etc.) are disabled by default on the duplicated database.
- Duplicate databases expire automatically after 15 days.
.. _online/rename:
.. _odoo_online/rename:
Rename
======
Rename the database and its URL.
.. _online/download:
.. _odoo_online/download:
Download
========
@@ -87,7 +87,7 @@ Download instantly a ZIP file with a backup of the database.
Databases are backed up daily according to the `Odoo Cloud SLA
<https://www.odoo.com/cloud-sla>`_.
.. _online/domains:
.. _odoo_online/domains:
Domains
=======
@@ -97,14 +97,14 @@ Configure custom domains to access the database via another URL.
.. seealso::
- :doc:`domain_names`
.. _online/tags:
.. _odoo_online/tags:
Tags
====
Add tags to sort your databases out. You can search the tags in the search bar.
.. _online/delete:
.. _odoo_online/delete:
Delete
======
@@ -118,7 +118,7 @@ Delete a database instantly.
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
.. image:: odoo_online/delete.png
:align: center
:alt: A warning message is prompted before deleting a database.
@@ -129,7 +129,7 @@ implications of deleting a database:
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:
.. _odoo_online/contact-support:
Contact Support
===============
@@ -137,7 +137,7 @@ Contact Support
Access the Odoo `support page <https://www.odoo.com/help>`_ with your database's details already
pre-filled.
.. _online/users:
.. _odoo_online/users:
Invite / Remove Users
=====================
@@ -145,7 +145,7 @@ 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
.. image:: odoo_online/invite-users.png
:align: center
:alt: Clicking on "Add more users" adds additional email fields.

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 19 KiB

Before

Width:  |  Height:  |  Size: 5.5 KiB

After

Width:  |  Height:  |  Size: 5.5 KiB

Before

Width:  |  Height:  |  Size: 6.0 KiB

After

Width:  |  Height:  |  Size: 6.0 KiB

Before

Width:  |  Height:  |  Size: 9.6 KiB

After

Width:  |  Height:  |  Size: 9.6 KiB

@@ -8,8 +8,9 @@ Supported versions
Odoo provides support and bug fixing **for the 3 last major versions** of Odoo.
.. 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.
Odoo releases intermediary versions called **Online versions** on the :doc:`Odoo Online
<odoo_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>` them regularly.
- Online versions are *not* released for Odoo.sh and On-Premise installations.
@@ -25,6 +26,8 @@ This matrix shows the support status of every version.
+-----------------+-------------+----------+-------------+----------------+------------------------+
| | Odoo Online | Odoo.sh | On-Premise | Release date | End of support |
+=================+=============+==========+=============+================+========================+
| **Odoo 16.0** | |green| | |green| | |green| | October 2022 | October 2025 (planned) |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo saas~15.2 | |green| | N/A | N/A | March 2022 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo saas~15.1 | |red| | N/A | N/A | February 2022 | |
@@ -33,7 +36,7 @@ This matrix shows the support status of every version.
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 14.0** | |green| | |green| | |green| | October 2020 | October 2023 (planned) |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 13.0** | |green| | |green| | |green| | October 2019 | October 2022 (planned) |
| **Odoo 13.0** | |red| | |red| | |red| | October 2019 | October 2022 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo saas~12.3 | |red| | N/A | N/A | August 2019 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
@@ -17,7 +17,7 @@ The platform will take care to install these dependencies in your containers.
`The pip requirements specifiers <https://pip.pypa.io/en/stable/reference/pip_install/#requirement-specifiers>`_
documentation can help you write a :file:`requirements.txt` file.
To have a concrete example,
check out the `requirements.txt file of Odoo <https://github.com/odoo/odoo/blob/14.0/requirements.txt>`_.
check out the `requirements.txt file of Odoo <{GITHUB_PATH}/requirements.txt>`_.
The :file:`requirements.txt` files of submodules are taken into account as well. The platform
looks for :file:`requirements.txt` files in each folder containing Odoo modules: Not in the module folder itself,
@@ -174,9 +174,9 @@ Look for "*odoo: addons paths*":
::
2018-02-19 10:51:39,267 4 INFO ? odoo: Odoo version 13.0
2018-02-19 10:51:39,267 4 INFO ? odoo: Odoo version {BRANCH}
2018-02-19 10:51:39,268 4 INFO ? odoo: Using configuration file at /home/odoo/.config/odoo/odoo.conf
2018-02-19 10:51:39,268 4 INFO ? odoo: addons paths: ['/home/odoo/data/addons/13.0', '/home/odoo/src/user', '/home/odoo/src/enterprise', '/home/odoo/src/themes', '/home/odoo/src/odoo/addons', '/home/odoo/src/odoo/odoo/addons']
2018-02-19 10:51:39,268 4 INFO ? odoo: addons paths: ['/home/odoo/data/addons/{BRANCH}', '/home/odoo/src/user', '/home/odoo/src/enterprise', '/home/odoo/src/themes', '/home/odoo/src/odoo/addons', '/home/odoo/src/odoo/odoo/addons']
**Be careful**, especially with your production database.
Operations that you perform running this Odoo server instance are not isolated:
@@ -29,4 +29,3 @@ We advise that:
- Your scheduled actions should be
`idempotent <https://stackoverflow.com/a/1077421/3332416>`_: they must not
cause side-effects if they are started more often than expected.
@@ -259,16 +259,16 @@ This server only keeps one month of backups: 7 daily and 4 weekly backups.
Dedicated backup servers keep the same backups, as well as 3 additional monthly backups.
To restore or download one of these monthly backups, please `contact us <https://www.odoo.com/help>`_.
If you merge a commit updating the version of one or several modules (in :file:`__manifest__.py`), or their linked python
dependencies (in :file:`requirements.txt`), then Odoo.sh performs a backup automatically (flagged with type Update in the list),
as either the container will be changed by the installation of new pip packages, either the database itself will be
changed with the module update triggered afterwards. In these two cases, we are doing a backup as it may potentially
If you merge a commit updating the version of one or several modules (in :file:`__manifest__.py`), or their linked python
dependencies (in :file:`requirements.txt`), then Odoo.sh performs a backup automatically (flagged with type Update in the list),
as either the container will be changed by the installation of new pip packages, either the database itself will be
changed with the module update triggered afterwards. In these two cases, we are doing a backup as it may potentially
break things.
If you merge a commit that only changes some code without the above-mentioned modifications, then no backup is done
by Odoo.sh, as neither the container nor the database is modified so the platform considers this safe enough. Of course,
as an extra precaution, you can make a backup manually before making big changes in your production sources in case
something goes wrong (those manual backups are available for about one week). To avoid abuse, we limit manual backups
If you merge a commit that only changes some code without the above-mentioned modifications, then no backup is done
by Odoo.sh, as neither the container nor the database is modified so the platform considers this safe enough. Of course,
as an extra precaution, you can make a backup manually before making big changes in your production sources in case
something goes wrong (those manual backups are available for about one week). To avoid abuse, we limit manual backups
to 5 per day.
The *import database* feature accepts database archives in the format provided by:
@@ -131,7 +131,7 @@ Odoo Online databases
.. Warning::
Saas releases (e.g. *saas-**) are not supported on Odoo.sh.
Online versions (e.g. *saas-**) are not supported on Odoo.sh.
Upload the backup
-----------------
@@ -1,14 +1,14 @@
==================================
=================
Your first module
==================================
=================
Overview
========
This chapter helps you to create your first Odoo module and deploy it in your Odoo.sh project.
This tutorial requires :ref:`you created a project on Odoo.sh <odoosh-gettingstarted-create>`, and you know your Github repository's URL.
This tutorial requires :ref:`you created a project on Odoo.sh <odoosh-gettingstarted-create>`, and
you know your Github repository's URL.
Basic use of Git and Github is explained.
@@ -95,8 +95,8 @@ Or, from your computer, if you have an :ref:`installation of Odoo <setup/install
$ ./odoo-bin scaffold my_module ~/src/odoo-addons/
If you do not want to bother installing Odoo on your computer,
you can also :download:`download this module structure template <first_module/my_module.zip>` in which you replace every occurrences of
*my_module* to the name of your choice.
you can also :download:`download this module structure template <first_module/my_module.zip>` in
which you replace every occurrences of *my_module* to the name of your choice.
The below structure will be generated:
@@ -121,9 +121,9 @@ The below structure will be generated:
.. Warning::
Do not use special characters other than the underscore ( _ ) for your module name, not even an hyphen ( - ).
This name is used for the Python classes of your module,
and having classes name with special characters other than the underscore is not valid in Python.
Do not use special characters other than the underscore ( _ ) for your module name, not even an
hyphen ( - ). This name is used for the Python classes of your module, and having classes name
with special characters other than the underscore is not valid in Python.
Uncomment the content of the files:
@@ -141,7 +141,7 @@ Uncomment the content of the files:
the manifest of your module, including for instance its title, description and data files to load.
You just need to uncomment the access control list data file:
.. code-block:: xml
.. code-block:: python
# 'security/ir.model.access.csv',
@@ -180,8 +180,8 @@ The above command is explained in the section
<odoosh-gettingstarted-online-editor-push>` of the
:ref:`Online Editor <odoosh-gettingstarted-online-editor>`
chapter.
It includes the explanation regarding the fact you will be prompted to type your username and password,
and what to do if you use the two-factor authentication.
It includes the explanation regarding the fact you will be prompted to type your username and
password, and what to do if you use the two-factor authentication.
Or, from your computer terminal:
@@ -217,7 +217,8 @@ Once the database ready, you can access it by clicking the *Connect* button.
:align: center
If your Odoo.sh project is configured to install your module automatically,
you will directly see it amongst the database apps. Otherwise, it will be available in the apps to install.
you will directly see it amongst the database apps. Otherwise, it will be available in the apps to
install.
You can then play around with your module, create new records and test your features and buttons.
@@ -232,7 +233,8 @@ you can test it with the production data using a staging branch.
You can either:
* Make your development branch a staging branch, by drag and dropping it onto the *staging* section title.
* Make your development branch a staging branch, by drag and dropping it onto the *staging* section
title.
.. image:: first_module/firstmodule-test-devtostaging.png
:align: center
@@ -244,8 +246,8 @@ You can either:
You can also use the :code:`git merge` command to merge your branches.
This will create a new staging build, which will duplicate the production database and make it run using a server
updated with your latest changes of your branch.
This will create a new staging build, which will duplicate the production database and make it run
using a server updated with your latest changes of your branch.
.. image:: first_module/firstmodule-test-mergedinstaging.png
:align: center
@@ -257,11 +259,13 @@ Once the database ready, you can access it using the *Connect* button.
Install your module
-------------------
Your module will not be installed automatically, you have to install it from the apps menu.
Indeed, the purpose of the staging build is to test the behavior of your changes as it would be on your production,
and on your production you would not like your module to be installed automatically, but on demand.
Your module will not be installed automatically, you have to install it from the apps menu. Indeed,
the purpose of the staging build is to test the behavior of your changes as it would be on your
production, and on your production you would not like your module to be installed automatically, but
on demand.
Your module may not appear directly in your apps to install either, you need to update your apps list first:
Your module may not appear directly in your apps to install either, you need to update your apps
list first:
* Activate the :ref:`developer mode <developer-mode>`
* in the apps menu, click the *Update Apps List* button,
@@ -307,14 +311,16 @@ you have to install it manually as explained in the
Add a change
============
This section explains how to add a change in your module by adding a new field in a model and deploy it.
This section explains how to add a change in your module by adding a new field in a model and deploy
it.
From the Odoo.sh editor,
* browse to your module folder *~/src/user/my_module*,
* then, open the file *models/models.py*.
Or, from your computer,
* use the file browser of your choice to browse to your module folder *~/src/odoo-addons/my_module*,
* use the file browser of your choice to browse to your module folder
*~/src/odoo-addons/my_module*,
* then, open the file *models/models.py* using the editor of your choice,
such as *Atom*, *Sublime Text*, *PyCharm*, *vim*, ...
@@ -350,8 +356,8 @@ and modify a view stored in database.
In order to be applied in existing databases, such as your production database,
these changes requires the module to be updated.
If you would like the update to be performed automatically by the Odoo.sh platform when you push your changes,
increase your module version in its manifest.
If you would like the update to be performed automatically by the Odoo.sh platform when you push
your changes, increase your module version in its manifest.
Open the module manifest *__manifest__.py*.
@@ -367,7 +373,8 @@ with
'version': '0.2',
The platform will detect the change of version and trigger the update of the module upon the new revision deployment.
The platform will detect the change of version and trigger the update of the module upon the new
revision deployment.
Browse to your Git folder.
@@ -414,10 +421,10 @@ The platform will then create a new build for the branch *feature-1*.
.. image:: first_module/firstmodule-test-addachange-build.png
:align: center
Once you tested your changes, you can merge your changes in the production branch, for instance by drag-and-dropping the
branch on the production branch in the Odoo.sh interface. As you increased the module version in the manifest,
the platform will update the module automatically and your new field will be directly available.
Otherwise you can manually update the module within the apps list.
Once you tested your changes, you can merge your changes in the production branch, for instance by
drag-and-dropping the branch on the production branch in the Odoo.sh interface. As you increased the
module version in the manifest, the platform will update the module automatically and your new field
will be directly available. Otherwise you can manually update the module within the apps list.
Use an external Python library
==============================
@@ -425,10 +432,18 @@ Use an external Python library
If you would like to use an external Python library which is not installed by default,
you can define a *requirements.txt* file listing the external libraries your modules depends on.
.. note::
- It is not possible to install or upgrade system packages on an Odoo.sh database (e.g., apt
packages). However, under specific conditions, packages can be considered for installation.
This also applies to **Python modules** requiring system packages for their compilation, and
**third-party Odoo modules**.
- **PostgreSQL extensions** are not supported on Odoo.sh.
- For more information, consult our `FAQ <https://www.odoo.sh/faq#install_dependencies>`_.
The platform will use this file to automatically install the Python libraries your project needs.
The feature is explained in this section by using the `Unidecode library <https://pypi.python.org/pypi/Unidecode>`_ in
your module.
The feature is explained in this section by using the `Unidecode library
<https://pypi.python.org/pypi/Unidecode>`_ in your module.
Create a file *requirements.txt* in the root folder of your repository
@@ -442,8 +457,8 @@ Add
unidecode
Then use the library in your module, for instance to remove accents from characters in the name field of your
model.
Then use the library in your module, for instance to remove accents from characters in the name
field of your model.
Open the file *models/models.py*.
+7 -7
View File
@@ -12,7 +12,7 @@ Upgrade
.. toctree::
:titlesonly:
upgrade/online_hosting
upgrade/odoo_online
upgrade/odoo_sh
upgrade/on_premise
upgrade/faq
@@ -22,8 +22,8 @@ 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)
* Switching :ref:`hosting type <upgrade-faq/hosting-types-switch>` (i.e., On-Premise to Odoo Online
or Odoo.sh)
* Migration from another ERP to Odoo
.. note:: |assistance-contact|
@@ -54,7 +54,7 @@ The upgrade process in a nutshell:
newly upgraded database (this is done automatically on Odoo Online).
.. seealso::
- :doc:`Upgrade process for Odoo Online (SaaS) <upgrade/online_hosting>`
- :doc:`Upgrade process for Odoo Online <upgrade/odoo_online>`
- :doc:`Upgrade process for Odoo.sh <upgrade/odoo_sh>`
- :doc:`Upgrade process for On-Premise <upgrade/on_premise>`
@@ -225,8 +225,8 @@ 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 services at all times.
Databases hosted on Odoos Cloud platforms (Odoo Online and Odoo.sh) or On-Premise (Self-Hosting)
enjoy the following services at all times.
The upgrade of:
@@ -254,4 +254,4 @@ Agreement <upgrade>` page.
.. seealso::
- :doc:`upgrade/faq`
- :doc:`odoo_sh`
- :doc:`maintain/supported_versions`
- :doc:`maintain/supported_versions`
+4 -4
View File
@@ -108,8 +108,8 @@ community or enterprise edition. It is required to have an enterprise subscripti
.. _upgrade-faq/hosting-types-switch:
Switching the hosting types (Self-Hosting vs. Online Hosting - SaaS vs. Cloud Platform - Odoo.sh)
=================================================================================================
Switching the hosting types (On-premise vs. Odoo Online vs. Odoo.sh)
====================================================================
An upgrade does not cover a change of `Hosting types <https://www.odoo.com/page/hosting-types>`_.
@@ -151,8 +151,8 @@ 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.
An Odoo Online 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?
=========================================================
@@ -1,6 +1,6 @@
==================
Odoo Online (SaaS)
==================
===========
Odoo Online
===========
Requesting a test upgrade
=========================
@@ -8,18 +8,20 @@ Requesting a test upgrade
#. Go to your `database manager <https://www.odoo.com/my/databases/>`_
#. Click on your profile icon and select *My Databases*.
.. image:: online_hosting/accessing-my-databases.png
.. image:: odoo_online/accessing-my-databases.png
:alt: Selecting My Databases under my profile
#. Click on the action settings icon next to your main database and select the *Upgrade* option.
#. Click on the up arrow button next to your main database name to proceed to the test upgrade.
.. image:: online_hosting/upgrade-option.png
.. image:: odoo_online/upgrade-option.png
:alt: Selecting the action settings icon
#. In the pop-up message that will appear, select Test Upgrade.
#. In the pop-up message that appears, select the target version and then :guilabel:`Test` as
purpose.
.. image:: online_hosting/select-test-upgrade.png
:alt: Selecting test upgrade
.. note::
The :guilabel:`Production` purpose doesn't appear if you didn't test your upgraded database at
least once.
#. This triggers the automated upgrade process. A confirmation email is then sent to you with the
the link to the upgraded database or to provide information if the upgrade failed.

Before

Width:  |  Height:  |  Size: 3.4 KiB

After

Width:  |  Height:  |  Size: 3.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.1 KiB

@@ -56,4 +56,4 @@ Depending on your contract, the upgrade of your custom modules can be done
#. by yourself.
#. by your Partner.
#. by Odoo (if you hold a subscription to 'Maintenance of Customizations').
#. by Odoo (if you hold a subscription to 'Maintenance of Customizations').
Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.4 KiB

+1 -1
View File
@@ -11,4 +11,4 @@ Finance
finance/expenses
finance/documents
finance/sign
finance/payment_providers
finance/payment_providers
@@ -2,71 +2,61 @@
Bank statements
===============
Importing your bank statements in Odoo Accounting allows you to keep track of the financial
movements that occur on your bank accounts and reconcile them with the transactions recorded in your
accounting.
Importing your bank statements allows you to keep track of your bank account transactions and
reconcile them with the ones recorded in Odoo.
We recommend you use bank synchronization for more efficiency. Please read the related
documentation: :doc:`bank_synchronization`.
We recommend using :doc:`the bank synchronization feature <bank_synchronization>` for more
efficiency. However, if you do not want to use it or if your bank is not yet supported, other
options exist:
However, if you don't want to use bank synchronization or if your bank is not a supported
institution, you still have other options:
#. Import the bank statement files delivered by your bank
#. Register the bank statements manually
- Import the bank statement files delivered by your bank;
- Register the bank statements manually.
Import bank statements files
============================
Odoo supports multiple file formats to import bank statements:
- SEPA recommended Cash Management format (CAMT.053)
- Comma-separated values (.CSV)
- Open Financial Exchange (.OFX)
- Quicken Interchange Format (.QIF)
- Belgium: Coded Statement of Account (.CODA)
- SEPA recommended Cash Management format (CAMT.053);
- Comma-separated values (.CSV);
- Open Financial Exchange (.OFX);
- Quicken Interchange Format (.QIF);
- Belgium: Coded Statement of Account (.CODA).
To import them, go to :menuselection:`Accounting --> Overview --> Bank`, click on *Import
Statements*, or on the three dots, and then on *Import Statement*.
To import a file, go to the Accounting dashboard and click on :guilabel:`Import (Statements)` under
the :guilabel:`Bank` window, or click on the drop-down menu (:guilabel:`⋮`) button and then on
:guilabel:`Import Statement`.
.. image:: bank_statements/bank-statements-01.png
.. image:: bank_statements/bank-overview.png
:align: center
:alt: Import a bank statement file in Odoo Accounting
Next, select the file you want to import and click on *Import*.
Next, select the file you want to import and click on :guilabel:`Upload`.
Odoo opens an **import widget** to help you set the **Formatting Options** and **map** the
different columns you want to import.
Once the file uploaded, the **import widget** helps you set formatting options and **map** the
different columns you want to import. You also can :guilabel:`test` the bank statement file before
importing it to your database.
.. image:: bank_statements/bank-statements-02.png
.. image:: bank_statements/import-bank-statement.png
:align: center
:alt: Register bank statements manually in Odoo Accounting
.. note::
Quicken Interchange Format (.QIF) is an older file format that is no longer supported since 2005.
If possible, prefer OFX files over QIF.
Register bank statements manually
=================================
If needed, you can also record your bank statements manually.
If needed, you can also record your bank statements manually. To do so, go to the
:guilabel:`Accounting dashboard` and click on the :guilabel:`Create Statements` under the
:guilabel:`Bank` window. Alternatively, you can click the drop-down menu (:guilabel:`⋮`) button, and
then :guilabel:`New Statement`.
To do so, go to :menuselection:`Accounting --> Overview --> Bank`, click on *Create Statements*, or
on the three dots, and then on *New Statement*.
Add a new line for each transaction written on the original bank statement.
To ease the reconciliation process, make sure to fill out the *Partner* field. You can also write
the payments references in the *Label* field.
To ease the reconciliation process, make sure to fill out the :guilabel:`Partner` field. You can
also type in the payments references in the :guilabel:`Label` field. Add a new line for each
transaction written on the original bank statement.
.. image:: bank_statements/bank-statements-03.png
:align: center
:alt: Register bank statements manually in Odoo Accounting
.. note::
The *Ending Balance* and the *Computed Balance* should have the same amount. If it is not the
case, make sure that there is no mistake in the transactions amounts.
.. seealso::
* :doc:`bank_synchronization`
.. todo:: add doc link to new documentation about reconciliation
The **Ending Balance** and the **Computed Balance** should have the same amount. If this is not
the case, make sure there are no mistakes in the transactions amounts.
Binary file not shown.

After

Width:  |  Height:  |  Size: 5.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

@@ -1,18 +1,15 @@
======================================
Bank synchronization: Automatic import
Bank synchronization: automatic import
======================================
Odoo can synchronize directly with your bank institution to get all bank statements imported
automatically into your database.
To check if your bank is compatible with Odoo, go to `Odoo Accounting Features
<https://www.odoo.com/page/accounting-features>`_, and click on *See list of supported institutions*.
<https://www.odoo.com/page/accounting-features>`_, and click on
:guilabel:`See list of supported institutions`.
.. image:: bank_synchronization/online-sync-doc.png
:align: center
:alt: Checking a bank's compatibility with Odoo
More than 20,000 institutions around the world are supported.
Odoo supports more than 25,000 institutions around the world.
To connect to the banks, Odoo uses multiple web-services:
@@ -20,9 +17,7 @@ To connect to the banks, Odoo uses multiple web-services:
- **Yodlee**: Worldwide
- **Salt Edge**: Europe (:doc:`more information <saltedge>`)
- **Ponto**: Europe (:doc:`more information <ponto>`)
.. important::
- Bank synchronization is not available for trial databases.
- **EnableBanking**: Scandinavian countries
Configuration
=============
@@ -38,49 +33,50 @@ following address:
- https://production.odoofin.com/
First Synchronization
First synchronization
---------------------
You can start synchronization either by going to :menuselection:`Accounting --> Configuration
--> Add a Bank Account` or via the configuration bar on the accounting dashboard.
You can start synchronization either by going to the Accounting app and
:menuselection:`Accounting Dashboard --> Configuration --> Banks: Add a Bank Account`.
Now you can search for your bank institution. Select it and follow the steps to synchronize with it.
.. note::
If you have any issues during your first synchronization, please verify that your
web browser doesn't block pop-ups and that your adblocker is disabled.
web browser doesn't block pop-ups and that your ad-blocker is disabled.
During your first synchronization, you will be asked for a phone number to secure your account.
The reason we ask for such information is that we don't want your data falling into the wrong
hands. Therefore, if we detect suspicious activity on your account, we block all requests coming
from your account, and you need to reactivate it using that phone number.
The third-party provider may request more information in order to connect with your bank institution.
.. important::
When choosing the date for the first bank statement synchronization, pick the date when you
start recording accounting transaction on your Odoo accounting database. For example, if you
import your closing balance in Odoo on the 31/12/2022 and you start recording accounting
transactions on the 01/01/2023, your synchronization date should be 01/01/2023.
You must provide a phone number during your first synchronization to secure your account. We ask for
such information because we don't want your data falling into the wrong hands. Therefore, if we
detect suspicious activities on your account, we block all requests coming from your account, and
you need to reactivate it using that phone number.
The third-party provider may request more information in order to connect with your
bank institution.
This information is not stored on Odoo's servers.
By default, transactions fetched from an online source are grouped inside the same statement, and
one bank statement is created per month. You can change the bank statement creation periodicity
in your journal settings.
You can find all your synchronizations by going to :menuselection:`Accounting --> Configuration -->
Online Synchronization`.
You can find all your synchronizations by going to :menuselection:`Accounting Dashboard -->
Configuration --> Accounting: Online Synchronization`.
Synchronize manually
--------------------
After your first synchronization, the created journals are synchronized by default every 12 hours.
If you wish, you can synchronize manually by clicking on the *Synchronize Now* button on the
dashboard.
If you wish, you can synchronize manually by clicking on the :guilabel:`Synchronize Now` button on
the dashboard.
.. image:: bank_synchronization/online-sync-sync-now-dashboard.png
:align: center
:alt: Synchronize Now Button
Or you can go to :menuselection:`Accounting --> Configuration --> Online Synchronization`,
select your institution and then click on the *Fetch Transactions* button.
.. image:: bank_synchronization/online-sync-form-view.png
:align: center
:alt: Online Synchronization Form view
Or you can go to :menuselection:`Accounting Dashboard --> Configuration -->
Accounting: Online Synchronization`, select your institution and then click on the
:guilabel:`fetch transactions` button.
.. important::
Some institutions do not allow transactions to be fetched automatically. For such institutions,
@@ -95,14 +91,14 @@ Synchronization in error
------------------------
To report a connection error to the `Odoo support <https://www.odoo.com/help>`_, go to
:menuselection:`Accounting --> Configuration --> Online Synchronization`, select the connection
that failed, and copy the error description and the reference.
:menuselection:`Accounting Dashboard--> Configuration --> Accounting: Online Synchronization`,
select the connection that failed, and copy the error description and the reference.
Synchronization disconnected
----------------------------
If your connection with the proxy is disconnected, you can reconnect with the proxy using the
*Reconnect* button.
:guilabel:`Fetch Account` button.
.. note::
This disconnection can be caused by the Odoo support. In this case, please contact the `support
@@ -121,24 +117,19 @@ Users who have created a database before December 2020 need to install the new m
use the new functionalities.
To do so, go to :menuselection:`Apps --> Update Apps List`, remove the default filter in the search
bar and type: **account_online_synchronization**. You can then click on the *Install* button to
install the new module.
.. image:: bank_synchronization/online-sync-module.png
:align: center
:alt: Installation button of the account_online_synchronization module
bar and type `account_online_synchronization`. You can then click on :guilabel:`Install`.
Finally, make sure all your users refresh their Odoo page by pressing CTRL+F5.
.. Note::
- All previous synchronizations are disconnected during the installation and won't work anymore.
You can find them directly in the synchronization menu (:menuselection:`Accounting -->
Configuration --> Online Synchronization`). It is not possible to resynchronize these
connections; you have to make new ones.
- Please do not uninstall *account_online_sync* which is the previous module for online
- You can find them directly in the synchronization menu
(:menuselection:`Accounting Dashboard --> Configuration -->
Accounting: Online Synchronization`). It is not possible to resynchronize these connections;
you have to make new ones.
- Do not uninstall `account_online_sync`, which is the previous module for online
synchronization. The new one overrides it.
- By default *account_online_synchronization* is installed automatically with Accounting.
- By default, `account_online_synchronization` is installed automatically with Accounting.
FAQ
===
@@ -148,14 +139,15 @@ The synchronization is not working in real-time. Is that normal?
The process is not intended to work in real-time as third party providers synchronize your accounts
at different intervals. To force the synchronization and fetch the statements, go to your
*Accounting dashboard*, and click on the *Synchronize Now* button. You can also synchronize and
fetch transactions through :menuselection:`Accounting --> Configuration --> Online Synchronization`.
Some providers only allow one refresh per day, so it is possible that clicking on *Synchronize Now*
does not get your latest transactions if you already performed such action earlier in the day.
:guilabel:`Accounting Dashboard`, and click on the :guilabel:`Synchronize Now` button. You can also
synchronize and fetch transactions through :menuselection:`Accounting Dashboard -->
Configuration --> Accounting: Online Synchronization`. Some providers only allow one refresh per
day, so it is possible that clicking on :guilabel:`Synchronize Now` does not get your latest
transactions if you already performed such action earlier in the day.
A transaction can be visible on your bank account, but not be fetched if it has the status
*Pending*. Only transactions with the *Posted* status will be retrieved. If it is not *Posted* yet,
you will have to wait until the status changes.
A transaction can be visible on your bank account but not be fetched if it has the status
:guilabel:`Pending`. Only transactions with the :guilabel:`Posted` status will be retrieved. If the
transaction is not **Posted** yet, you will have to wait until the status changes.
Is the Online Bank Synchronization feature included in my contract?
-------------------------------------------------------------------
@@ -188,8 +180,9 @@ Why don't I see any transactions?
---------------------------------
During your first synchronization, you selected the bank accounts you decided to synchronize with
Odoo. If you didn't synchronize any of your accounts, you can go to :menuselection:`Accounting -->
Configuration --> Online Synchronization` to click on the *Fetch Accounts* button on the connection.
Odoo. If you didn't synchronize any of your accounts, you can go to
:menuselection:`Accounting Dashboard --> Configuration --> Accounting: Online Synchronization` to
click on the :guilabel:`Fetch Account` button on the connection.
There may also be no new transactions.
@@ -199,9 +192,9 @@ database, please `submit a support ticket <https://www.odoo.com/help>`_.
How can I update my bank credentials?
-------------------------------------
You can update your credentials by going to :menuselection:`Accounting --> Configuration --> Online
Synchronization`, open the connection you want to update your credentials and click on the *Update
Credentials* button.
You can update your credentials by going to :menuselection:`Accounting Dashboard -->
Configuration --> Accounting: Online Synchronization`,open the connection you want to update your
credentials and click on the :guilabel:`Update Credentials` button.
.. seealso::
* :doc:`bank_statements`
Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.4 KiB

@@ -64,8 +64,8 @@ Link your Ponto account with your Odoo database
#. Finish the flow.
.. note::
You have to authorize all the accounts you want to access in Odoo but, Odoo will filter the
accounts based on the institution you selected at the second step.
You have to authorize all the accounts you want to access in Odoo, but Odoo will filter the
accounts based on the institution you selected in the second step.
Update your synchronization credentials
---------------------------------------
@@ -80,12 +80,12 @@ FAQ
I have an error when I try to delete my synchronization within Odoo
-------------------------------------------------------------------
Odoo can't permanently delete the connection you have created with the banking institution. However,
it can revoke the consent you gave so that Odoo won't be able to access your account anymore. The
error you are seeing is probably a message telling you that the consent was revoked, but the record
could not be deleted as it still exists within Salt edge. If you want to remove the connection
completely, please connect to your `Salt Edge account <https://www.saltedge.com/dashboard>`_
and manually delete your synchronization. Once this is done, you can go back to Odoo to delete the
Odoo can't permanently delete the connection you have created with the banking institution. However,
it can revoke the consent you gave so that Odoo won't be able to access your account anymore. The
error you are seeing is probably a message telling you that the consent was revoked, but the record
could not be deleted as it still exists within Salt edge. If you want to remove the connection
completely, please connect to your `Salt Edge account <https://www.saltedge.com/dashboard>`_
and manually delete your synchronization. Once this is done, you can go back to Odoo to delete the
record.
I have an error saying that I have already synchronized this account
@@ -7,4 +7,4 @@ Miscellaneous
.. toctree::
:titlesonly:
misc/interbank
misc/interbank
@@ -1,132 +1,147 @@
================================================
Do a bank wire transfer from one bank to another
================================================
=================
Internal transfer
=================
A company might have several bank accounts or cash registers. Within
odoo it is possible to handle internal transfers of money with only a
couple of clicks.
We will take the following example to illustrate. My company has two
bank accounts and I want to transfer 50.000 euros from one of our bank
accounts to the another one.
In Odoo, internal money transfers can be made in a few clicks. You need at least either two bank
accounts, two cash journals, or one bank account and one cash journal.
Configuration
=============
Check your Chart of Accounts and default transfer account
---------------------------------------------------------
An internal transfer account is automatically created on your database based on your company's
localization and depending on your countrys legislation. If needed, the default :guilabel:`Internal
transfer account` can be modified by going to :menuselection:`Accounting app --> Configuration -->
Settings` and then under the :guilabel:`Default Accounts` section.
To handle internal transfers you need a transfer account in your charts
of account. Odoo will generate an account automatically based on the
country of your chart of account. To configure your chart of accounts and
check the default transfer account go into the accounting module settings,
select :menuselection:`Configuration --> Settings`.
.. note::
At least two bank accounts are needed to make internal transfers. Refer to
:doc:`Bank and cash accounts section <../setup/bank_accounts>` to see how to add an additional
bank account to your database.
Your chart of accounts will be pre-installed depending on the country
specified during your registration, it cannot be changed.
Register an internal transfer from one bank to another
======================================================
.. image:: interbank/interbank04.png
:align: center
The default transfer account will automatically be generated as well
depending on your country's legislation. If necessary it can be modified
from the same page.
.. image:: interbank/interbank05.png
:align: center
Create a second bank account / Journal
--------------------------------------
Before we can register an internal transfer we need to add a new bank to
our accounting dashboard. To do so enter the accounting module, click on
:menuselection:`Configuration --> Bank Accounts`. Create a new bank account. You should
fill in the **Account Number**. You can also create and edit your bank to
specify your bank's details.
.. image:: interbank/interbank03.png
:align: center
By saving the changes you now have 2 bank accounts.
.. image:: interbank/interbank06.png
:align: center
Register an internal transfer from one bank to another.
=======================================================
We will now transfer 50.000 euros from our **Bank** to our **Bank BE57 0633
9533 1498** account.
Let's say you have two bank accounts registered on your database and you want to transfer 1,000 USD
from Bank A to Bank B.
Log an internal transfer
------------------------
The first step is to register the internal payment. To do so go into
your accounting dashboard, click on the **more** button of one of your banks
and select :menuselection:`New --> Internal transfer`.
From the Accounting Dashboard, click on the drop-down selection button (:guilabel:`⋮`) on one of
your banks. In the :guilabel:`New` column click on :guilabel:`Internal Transfer` and enter the
information related to the transfer.
.. image:: interbank/interbank01.png
.. image:: interbank/internal_transfer.png
:align: center
Create a new payment. The payment type will automatically be set to
internal transfer. Select the **Bank** you want to transfer to, specify the
**Amount** and add a **Memo** if you wish.
:alt: Fill in the information related to your internal transfer
.. note::
The memo is important if you wish to automatically reconcile (see `Import bank statements and
reconcile`_).
Fill in the :guilabel:`Memo` field for automatic reconciliation.
.. image:: interbank/interbank02.png
:guilabel:`Save` and :guilabel:`Confirm` to register your internal transfer. The money is now booked
in the transfer account and another payment is **automatically** created in the destination journal
(Bank B).
Bank journal (Bank A)
~~~~~~~~~~~~~~~~~~~~~
.. list-table::
:header-rows: 1
:stub-columns: 1
* - **Account**
- **Debit**
- **Credit**
* - Outstanding Payments account
-
- $1,000
* - **Internal transfer account**
- **$1,000**
-
Automated booking - Bank journal (BANK B)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. list-table::
:header-rows: 1
:stub-columns: 1
* - **Account**
- **Debit**
- **Credit**
* - Outstanding Receipts account
- $1,000
-
* - **Internal transfer account**
-
- **$1,000**
.. note::
There are one outstanding payment and one outstanding receipt pending in your two bank account
journals, because the bank statement confirming the sending and receiving of the money has not
been booked yet.
.. image:: interbank/outstanding-payments-receipts.png
:align: center
:alt: Outstanding Payments/Receipts pending bank statement booking
Save and confirm the changes to register the payment.
.. _interbank/import-and-reconcile:
In terms of accounting the money is now booked in the transfer account.
We'll need to import bank statements to book the money in the final
accounts.
Import bank statements and reconcile
Manage and reconcile bank statements
------------------------------------
Note that the bank balance computed by Odoo is different that the last
statement of your bank.
The next step is to book the bank statements to finalize the transaction by creating,
:doc:`importing <../feeds/bank_statements>`, or :doc:`synchronizing <../feeds/bank_synchronization>`
your :guilabel:`Transactions lines`. Fill in the :guilabel:`Ending balance` and click on the
:guilabel:`Reconcile` button.
.. image:: interbank/interbank11.png
.. image:: interbank/transactions-line.png
:align: center
:alt: Transaction lines to be filled in prior to reconciliation
That is because we did not import the bank statement confirming the
receiving and sending of the money. It's thus necessary to import your
bank statement and reconcile the payment with the correct bank statement
line. Once you receive your bank statements click the **new statement**
button of the corresponding bank to import them.
.. seealso::
- :doc:`../reconciliation/use_cases`
.. image:: interbank/interbank07.png
In the next window, choose counterparts for the payment - in this example, the outstanding payment
account - then click :guilabel:`Validate`.
.. image:: interbank/bank-reconciliation.png
:align: center
:alt: Reconcile your payment
Fill in your **Transactions line**. Once done, Odoo will display a **Computed
Balance**. that computed balance is the theorical end balance of your
bank account. If it's corresponding to the bank statement, it means that no errors were
made. Fill in the **Ending balance** and click on the **Reconcile** button.
Bank journal entry
~~~~~~~~~~~~~~~~~~
.. image:: interbank/interbank10.png
:align: center
.. list-table::
:header-rows: 1
:stub-columns: 1
The following window will open:
* - **Account**
- **Debit**
- **Credit**
* - Outstanding Payment
- $1,000
-
* - Bank Account (BANK A)
-
- **$1,000**
.. image:: interbank/interbank09.png
:align: center
The same steps must be repeated once you receive the bank statement related to Bank B. Book and
reconcile your bank statement lines.
You need to choose counterparts for the payment. Select the correct
bank statement line corresponding to the payment and click on the
**reconcile** button. Close the statement to finish the transaction
Bank journal entry
~~~~~~~~~~~~~~~~~~
.. image:: interbank/interbank08.png
:align: center
.. list-table::
:header-rows: 1
:stub-columns: 1
The same steps will need to be repeated once you receive your second
bank statement. Note that if you specify the same amount and the
same memo in both bank statements and payment transactions then the
reconciliation will happen automatically.
.. image:: interbank/interbank12.png
:align: center
* - **Account**
- **Debit**
- **Credit**
* - Outstanding Receipt
-
- $1,000
* - Bank Account (BANK B)
- **$1,000**
-
Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

@@ -8,4 +8,4 @@ Bank reconciliation
:titlesonly:
reconciliation/use_cases
reconciliation/reconciliation_models
reconciliation/reconciliation_models
@@ -126,4 +126,4 @@ line*.
- :doc:`use_cases`
- :doc:`../feeds/bank_synchronization`
- :doc:`../../receivables/customer_invoices/cash_discounts`
- :doc:`../../receivables/customer_invoices/cash_discounts`
@@ -102,4 +102,4 @@ right and validate all related payments :
:align: center
.. seealso::
* :doc:`../feeds/bank_synchronization`
* :doc:`../feeds/bank_synchronization`
@@ -1,95 +1,136 @@
=============
Bank Accounts
=============
You can manage as many **Bank Accounts** as needed on your database. Configuring them well allows
you to make sure that all your banking data is up to date and ready for the reconciliation with your
*Journal Entries*.
In Odoo Accounting, each Bank Account is configured to have a dedicated *Journal* which is
configured to post all entries in a dedicated *Account*.
.. note:: Whenever you add a Bank Account, a dedicated journal and a dedicated account are
automatically created and configured.
Every **Bank Journal** is displayed by default on the **Accounting Overview** in the form of a
convenient card. It includes action buttons that are displayed when appropriate.
.. image:: bank_accounts/bank_accounts_card.png
:align: center
:alt: Bank Journals Cards are displayed on the Accounting Overview in Odoo Accounting
.. _bank_accounts_add:
Add a new Bank Account
======================
Bank and cash accounts
======================
You can either connect your bank account to your Odoo database, or configure your bank account
manually and :doc:`upload the bank statements manually <../feeds/bank_statements>`.
You can manage as many bank or cash accounts as needed on your database. Configuring them well
allows you to have all your banking data up-to-date and ready for :doc:`reconciliation
<../../bank/reconciliation/use_cases>` with your journal entries.
Bank Synchronization
--------------------
Connect your bank account to your database and have your bank statements synced automatically.
To synchronize a new bank account, go to :menuselection:`Accounting --> Configuration`, click on
*Add a Bank Account*, then find your bank in the list, click on *Connect*, and follow the
instructions on-screen.
In Odoo Accounting, each bank account has a dedicated journal set to post all entries in a dedicated
account. Both the journal and the account are automatically created and configured whenever you add
a bank account.
.. note::
:doc:`Click here <../../bank/feeds/bank_synchronization>` for more information about this bank
synchronization.
Cash journals and accounts must be configured manually.
.. image:: bank_accounts/bank_accounts_connect.png
Bank journals are displayed by default on the :guilabel:`Accounting Dashboard` in the form of cards
which include action buttons.
.. image:: bank_accounts/card.png
:align: center
:alt: Select a bank institution in the list and connect it to Odoo Accounting
:alt: Bank journals are displayed on the Accounting Dashboard and contain action buttons
Manual configuration
--------------------
.. _bank_accounts/manage:
If your Bank Institution cant be synchronized automatically, or if you prefer not to sync it with
your database, you may also configure your bank account manually.
Manage your bank and cash accounts
==================================
To add a new bank account manually, go to :menuselection:`Accounting --> Configuration`, click on
*Add a Bank Account*, then on *Create it*, and fill out the form.
Connect your bank for automatic synchronization
-----------------------------------------------
- **Name**: the bank account's name, as displayed on Odoo.
- **Account Number**: your bank account number (IBAN in Europe).
- **Bank**: click on *Create and Edit* to configure the bank's details. Add the bank institution's
name and its Identifier Code (BIC or SWIFT).
- **Code**: this code is your Journal's *Short Code*, as displayed on Odoo. By default, Odoo creates
a new Journal with this Short Code.
- **Journal**: This field is displayed if you have an existing Bank Journal that is not linked yet
to a bank account. If so, then select the *Journal* you want to use to record the financial
transactions linked to this bank account or create a new one by clicking on *Create and Edit*.
.. note::
Odoo detects the bank account type (e.g., IBAN) and enables some features accordingly.
.. image:: bank_accounts/bank_accounts_manual.png
:align: center
:alt: Add manually a new bank account in Odoo Accounting
.. _bank_accounts_configuration:
Advanced configuration
======================
To edit an existing bank account, go to :menuselection:`Accounting --> Configuration --> Bank
Accounts`, and open the bank account you want to modify.
If you need to edit the bank account details, go to the *Bank Account* field and click on the
*External Link* button next to the list arrow. There, you can edit the bank account's number,
Account Holder, Account Holder Name, and your Bank Institution's details by clicking on the
*External Link* next to the *Bank* field. These details are used to register some payments.
You can configure which types of payments are enabled in the **Payment Method Types** section and
how the bank statements are recorded and posted in the **Bank Statements** section.
.. image:: bank_accounts/bank_accounts_configuration.png
:align: center
:alt: Advanced configuration of a bank account in Odoo Accounting
To connect your bank account to your database, go to :menuselection:`Accounting --> Configuration
--> Banks: Add a Bank Account`, select your bank in the list, click on :guilabel:`Connect`, and
follow the instructions.
.. seealso::
* :doc:`../../bank/feeds/bank_synchronization`
* :doc:`../feeds/bank_statements`
* `Odoo Tutorials: Accounting Basics <https://www.odoo.com/r/lsZ>`_
:doc:`../../bank/feeds/bank_synchronization`
Create a bank account
---------------------
If your banking institution is not available in Odoo, or if you don't want to connect your bank
account to your database, you can configure your bank account manually.
To manually add a bank account, go to :menuselection:`Accounting --> Configuration --> Banks:
Add a Bank Account`, click on :guilabel:`Create it` (at the bottom right), and fill out the form.
.. note::
- Odoo automatically detects the bank account type (e.g., IBAN) and enables some features
accordingly.
- A default bank journal is available and can be used to configure your bank account by going to
:menuselection:`Accounting --> Configuration --> Accounting: Journals --> Bank`. Open it and
edit the different fields to match your bank account information.
Create a cash journal
---------------------
To create a new cash journal, go to :menuselection:`Accounting --> Configuration --> Accounting:
Journals`, click on :guilabel:`Create` and select :guilabel:`Cash` in the :guilabel:`Type` field.
For more information on the accounting information fields, read the
:ref:`bank_accounts/configuration` section of this page.
.. note::
A default cash journal is available and can be used straight away. You can review it by going to
:menuselection:`Accounting --> Configuration --> Accounting: Journals --> Cash`.
Edit an existing bank or cash journal
-------------------------------------
To edit an existing bank journal, go to :menuselection:`Accounting --> Configuration --> Accounting:
Journals` and select the journal you want to modify.
.. _bank_accounts/configuration:
Configuration
=============
You can edit the accounting information and bank account number according to your needs.
.. image:: bank_accounts/bank-journal-config.png
:align: center
:alt: Manually configure your bank information
.. seealso::
- :doc:`../../others/multi_currency`
- :doc:`../../bank/feeds/bank_statements`
- :doc:`../../bank/setup/outstanding_accounts`
Suspense account
----------------
Bank statement transactions are posted on the :guilabel:`Suspense Account` until the final
reconciliation allows finding the right account.
Profit and loss accounts
------------------------
The :guilabel:`Profit Account` is used to register a profit when the ending balance of a cash
register differs from what the system computes, while the :guilabel:`Loss Account` is used to
register a loss when the ending balance of a cash register differs from what the system computes.
Currency
--------
You can edit the currency used to enter the statements.
.. seealso::
:doc:`../../others/multi_currency`
Account number
--------------
If you need to **edit your bank account details**, click on the external link arrow next to your
:guilabel:`Account Number`. On the new page, click on the external link arrow next to your
:guilabel:`Bank` and update your bank information accordingly. These details are used when
registering payments.
.. image:: bank_accounts/bank-account-number.png
:align: center
:alt: Edit your bank information
Bank feeds
----------
:guilabel:`Bank Feeds` defines how the bank statements are registered. Three options are available:
- :guilabel:`Undefined yet`, which should be selected when you dont know yet if you will
synchronize your bank account with your database or not.
- :guilabel:`Import (CAMT, CODA, CSV, OFX, QIF)`, which should be selected if you want to import
your bank statement using a different format.
- :guilabel:`Automated Bank Synchronization`, which should be selected if your bank is synchronized
with your database.
.. seealso::
- :doc:`../../bank/feeds/bank_synchronization`
- :doc:`../../bank/feeds/bank_statements`
Binary file not shown.

After

Width:  |  Height:  |  Size: 7.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.4 KiB

@@ -114,4 +114,4 @@ gains/losses** have been adjusted.
.. image:: foreign_currency/foreign-adjustment.png
:align: center
:alt: Unrealized Currency Gains/Losses report once adjusted.
:alt: Unrealized Currency Gains/Losses report once adjusted.
@@ -11,7 +11,7 @@ Configuration
.. image:: manage_cash_register/journal.png
:align: center
1. Configure the Cash journal in :menuselection:`Accounting --> Configuration -->
1. Configure the Cash journal in :menuselection:`Accounting --> Configuration -->
Journals`.
2. In the tab Journal Entries, the Default Debit and Credit Account can be
@@ -8,4 +8,4 @@ Fiscal localizations
:titlesonly:
fiscal_localizations/overview
fiscal_localizations/localizations
fiscal_localizations/localizations
Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

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