Odoo Documentation

https://www.odoo.com/documentation/16.0
Admin
This documentation provides a comprehensive guide for users to configure and utilize the Odoo...
Tokens:426,503
Snippets:7,029
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Initialize Todo component state

Source: https://www.odoo.com/documentation/16.0/developer/tutorials/discover_js_framework/01_owl_components.html

Example of setting up a todo object within the component setup method.

```javascript
setup() {
    ...
    this.todo = { id: 3, description: "buy milk", done: false };
}
```

--------------------------------

### Install Make on Linux

Source: https://www.odoo.com/documentation/16.0/contributing/documentation.html

Installs the Make build tool on Linux systems.

```bash
$ sudo apt install make -y
```

--------------------------------

### Title Parts Example

Source: https://www.odoo.com/documentation/16.0/developer/reference/frontend/services.html

Example of a parts object configuration.

```javascript
{ odoo: "Odoo", action: "Import" }
```

--------------------------------

### Install PostgreSQL on Linux

Source: https://www.odoo.com/documentation/16.0/administration/on_premise/source.html

Install PostgreSQL and the client tools using the system package manager.

```bash
$ sudo apt install postgresql postgresql-client
```

--------------------------------

### Install Odoo dependencies on Debian/Ubuntu

Source: https://www.odoo.com/documentation/16.0/administration/on_premise/source.html

Use the provided setup script to install required packages on Debian-based systems.

```bash
$ cd odoo #CommunityPath
$ sudo ./setup/debinstall.sh
```

--------------------------------

### Window Action Configuration Examples

Source: https://www.odoo.com/documentation/16.0/developer/reference/backend/actions.html

Examples of defining window actions for listing customers or opening specific records in a dialog.

```json
{
    "type": "ir.actions.act_window",
    "res_model": "res.partner",
    "views": [[False, "tree"], [False, "form"]],
    "domain": [["customer", "=", true]],
}
```

```json
{
    "type": "ir.actions.act_window",
    "res_model": "product.product",
    "views": [[False, "form"]],
    "res_id": a_product_id,
    "target": "new",
}
```

--------------------------------

### Install PostgreSQL on Linux

Source: https://www.odoo.com/documentation/16.0/administration/on_premise/packages.html

Commands to install and initialize the PostgreSQL server required for Odoo.

```bash
$ sudo apt install postgresql -y
```

```bash
$ sudo dnf install -y postgresql-server
$ sudo postgresql-setup --initdb --unit postgresql
$ sudo systemctl enable postgresql
$ sudo systemctl start postgresql
```

--------------------------------

### Install Upgrade utils via pip

Source: https://www.odoo.com/documentation/16.0/developer/reference/upgrades/upgrade_utils.html

Install the library directly from the GitHub repository using pip.

```bash
$ python3 -m pip install git+https://github.com/odoo/upgrade-util@master
```

--------------------------------

### Launch Odoo Server via CLI

Source: https://www.odoo.com/documentation/16.0/administration/on_premise/source.html

Commands to start the Odoo server from the installation root directory.

```bash
$ cd /CommunityPath
$ python3 odoo-bin --addons-path=addons -d mydb
```

```batch
C:\> cd CommunityPath/
C:\> python odoo-bin -r dbuser -w dbpassword --addons-path=addons -d mydb
```

--------------------------------

### SCSS and CSS Syntax Examples

Source: https://www.odoo.com/documentation/16.0/contributing/development/coding_guidelines.html

Examples showing SCSS nesting and the resulting compiled CSS structure.

```scss
.o_foo, .o_foo_bar, .o_baz {
   height: $o-statusbar-height;

   .o_qux {
      height: $o-statusbar-height * 0.5;
   }
}

.o_corge {
   background: $o-list-footer-bg-color;
}

```

```css
.o_foo, .o_foo_bar, .o_baz {
   height: 32px;
}

.o_foo .o_quux, .o_foo_bar .o_quux, .o_baz .o_qux {
   height: 16px;
}

.o_corge {
   background: #EAEAEA;
}

```

--------------------------------

### Initialize Class Instances

Source: https://www.odoo.com/documentation/16.0/developer/tutorials/web.html

Define an init() method to perform setup logic when a class is instantiated.

```javascript
var MyClass = instance.web.Class.extend({
    init: function(name) {
        this.name = name;
    },
    say_hello: function() {
        console.log("hello", this.name);
    },
});

var my_object = new MyClass("Bob");
my_object.say_hello();
// print "hello Bob" in the console
```

--------------------------------

### Install geoip2 library

Source: https://www.odoo.com/documentation/16.0/administration/on_premise/geo_ip.html

Install the required Python library for GeoIP functionality.

```bash
pip install geoip2
```

--------------------------------

### Register a Main Component

Source: https://www.odoo.com/documentation/16.0/developer/reference/frontend/registries.html

Example of adding a component to the main_components registry.

```javascript
registry.category("main_components").add("LoadingIndicator", {
  Component: LoadingIndicator,
});
```

--------------------------------

### Implement Widget Start Lifecycle

Source: https://www.odoo.com/documentation/16.0/developer/reference/frontend/javascript_reference.html

Ensure the super method is called and promises are returned correctly in the start method to maintain execution order.

```javascript
var Widget = require('web.Widget');

var AlmostCorrectWidget = Widget.extend({
    start: function () {
        this.$el.hasClass(....) // in theory, $el is already set, but you don't know what the parent will do with it, better call super first
        return this._super.apply(arguments);
    },
});

var IncorrectWidget = Widget.extend({
    start: function () {
        this._super.apply(arguments); // the parent promise is lost, nobody will wait for the start of this widget
        this.$el.hasClass(....)
    },
});

var CorrectWidget = Widget.extend({
    start: function () {
        var self = this;
        return this._super.apply(arguments).then(function() {
            self.$el.hasClass(....) // this works, no promise is lost and the code executes in a controlled order: first super, then our code.
        });
    },
});
```

--------------------------------

### Install macOS Command Line Tools

Source: https://www.odoo.com/documentation/16.0/administration/on_premise/source.html

Install the necessary command line tools for macOS development environments.

```bash
$ xcode-select --install
```

--------------------------------

### Start the Odoo server

Source: https://www.odoo.com/documentation/16.0/developer/tutorials/backend.html

Command to initiate the Odoo server process.

```bash
odoo-bin
```

--------------------------------

### Create a numbered list with custom start

Source: https://www.odoo.com/documentation/16.0/contributing/documentation/rst_guidelines.html

Specify the starting number manually for the first item, then use #. for subsequent items.

```rst
6. Use this format to start the numbering
   with a number other than one.
#. The numbering is automatic from there.
```

--------------------------------

### Clone the Odoo Petstore Module

Source: https://www.odoo.com/documentation/16.0/developer/tutorials/web.html

Use this command to download the example module from the Odoo repository.

```bash
$ git clone http://github.com/odoo/petstore
```

--------------------------------

### Inspect widget DOM structure

Source: https://www.odoo.com/documentation/16.0/developer/tutorials/web.html

Example of the resulting HTML structure after nesting widgets with custom classes.

```html
<div class="oe_petstore_homepage">
    <div>Hello dear Odoo user!</div>
    <div class="oe_petstore_greetings">
        <div>We are so happy to see you again in this menu!</div>
    </div>
</div>
```

--------------------------------

### Call model methods with keyword arguments

Source: https://www.odoo.com/documentation/16.0/developer/tutorials/web.html

Examples of defining and calling a method with keyword arguments.

```python
@api.model
def my_method2(self, a, b, c): ...
```

```javascript
model.call("my_method", [], {a: 1, b: 2, c: 3, ...
// with this a=1, b=2 and c=3
```

--------------------------------

### Call model methods with positional arguments

Source: https://www.odoo.com/documentation/16.0/developer/tutorials/web.html

Examples of defining and calling a method with positional arguments.

```python
@api.model
def my_method2(self, a, b, c): ...
```

```javascript
model.call("my_method", [1, 2, 3], ...
// with this a=1, b=2 and c=3
```

--------------------------------

### Manage Widget Properties

Source: https://www.odoo.com/documentation/16.0/developer/tutorials/web.html

Use set() and get() to manage widget data and listen for property change events.

```javascript
start: function() {
    this.widget = ...
    this.widget.on("change:name", this, this.name_changed);
    this.widget.set("name", "Nicolas");
},
name_changed: function() {
    console.log("The new value of the property 'name' is", this.widget.get("name"));
}
```

--------------------------------

### Display content in a widget

Source: https://www.odoo.com/documentation/16.0/developer/tutorials/web.html

Uses the $el property to inject HTML content into the widget's root element during the start lifecycle method.

```javascript
local.HomePage = instance.Widget.extend({
    start: function() {
        this.$el.append("<div>Hello dear Odoo user!</div>");
    },
});
```

--------------------------------

### Define a basic Odoo Widget

Source: https://www.odoo.com/documentation/16.0/developer/tutorials/web.html

Extends the base Widget class and overrides the start method to perform initialization tasks.

```javascript
local.HomePage = instance.Widget.extend({
    start: function() {
        console.log("pet store home page loaded");
    },
});
```

--------------------------------

### Bind DOM events using jQuery handlers

Source: https://www.odoo.com/documentation/16.0/developer/tutorials/web.html

Standard jQuery event binding within the start() method, which may require manual this-binding.

```javascript
local.MyWidget = instance.Widget.extend({
    start: function() {
        var self = this;
        this.$(".my_button").click(function() {
            self.button_clicked();
        });
    },
    button_clicked: function() {
        ..
    },
});
```

--------------------------------

### POST /start

Source: https://www.odoo.com/documentation/16.0/developer/api/external_api.html

Initializes a new test database and returns connection information including host, database name, username, and password.

```APIDOC
## POST /start

### Description
Requests a new test database from the Odoo demo server.

### Endpoint
https://demo.odoo.com/start

### Response
- **host** (string) - The host URL for the database.
- **database** (string) - The name of the database.
- **user** (string) - The username for authentication.
- **password** (string) - The password for authentication.
```

--------------------------------

### Clone the tutorials repository

Source: https://www.odoo.com/documentation/16.0/developer/tutorials/getting_started/02_setup.html

Use this command to clone the tutorials repository to your local machine.

```bash
$ git clone git@github.com:odoo/tutorials.git
```

--------------------------------

### Install Enterprise .deb package

Source: https://www.odoo.com/documentation/16.0/administration/on_premise/community_to_enterprise.html

Command to install the Odoo Enterprise package over the existing Community installation.

```bash
$ sudo dpkg -i <path_to_enterprise_deb>
```

--------------------------------

### Component Initialization Best Practices

Source: https://www.odoo.com/documentation/16.0/developer/reference/frontend/owl_components.html

Use the setup method instead of the constructor for component initialization to ensure compatibility with Odoo's component lifecycle.

```javascript
// correct:
class MyComponent extends Component {
    setup() {
        // initialize component here
    }
}

// incorrect. Do not do that!
class IncorrectComponent extends Component {
    constructor(parent, props) {
        // initialize component here
    }
}
```

--------------------------------

### Install Python Dependencies

Source: https://www.odoo.com/documentation/16.0/contributing/documentation.html

Installs required Python packages using pip.

```bash
$ pip install -r requirements.txt
```

--------------------------------

### Create and use a Registry

Source: https://www.odoo.com/documentation/16.0/developer/reference/frontend/registries.html

Demonstrates initializing a new registry instance, adding a value, and retrieving it.

```javascript
import { Registry } from "@web/core/registry";

const myRegistry = new Registry();

myRegistry.add("hello", "odoo");

console.log(myRegistry.get("hello"));
```

--------------------------------

### Sample Odoo Configuration File

Source: https://www.odoo.com/documentation/16.0/developer/reference/cli.html

Example of the [options] section in an .odoorc configuration file.

```ini
[options]
db_user=odoo
dbfilter=odoo

```

--------------------------------

### Install and Trigger Python Debugger

Source: https://www.odoo.com/documentation/16.0/developer/tutorials/getting_started/02_setup.html

Install the ipdb library and insert a breakpoint into the source code.

```bash
pip install ipdb
```

```python
import ipdb; ipdb.set_trace()
```

--------------------------------

### Install Python requirements via pip

Source: https://www.odoo.com/documentation/16.0/administration/on_premise/source.html

Install Odoo Python dependencies from the requirements.txt file.

```bash
$ cd /CommunityPath
$ pip install -r requirements.txt
```

```bash
$ cd /CommunityPath
$ pip3 install setuptools wheel
$ pip3 install -r requirements.txt
```

```cmd
C:\> cd \CommunityPath
C:\> pip install setuptools wheel
C:\> pip install -r requirements.txt
```

--------------------------------

### Install Debugger Packages

Source: https://www.odoo.com/documentation/16.0/administration/odoo_sh/advanced/containers.html

Commands to install pudb or ipdb temporarily in the current build environment.

```bash
$  pip install pudb --user
```

```bash
$  pip install ipdb --user
```

--------------------------------

### Widget.start()

Source: https://www.odoo.com/documentation/16.0/developer/reference/frontend/javascript_reference.html

Method called after rendering is complete to perform post-rendering tasks.

```APIDOC
## Widget.start()

### Description
Called automatically by the framework when rendering is complete. Used for specialized post-rendering work such as setting up libraries.

### Returns
- **promise** - Indicates when the work is completed.
```

--------------------------------

### Install Odoo via Distribution Package

Source: https://www.odoo.com/documentation/16.0/administration/on_premise/packages.html

Commands to manually install downloaded Odoo packages.

```bash
# dpkg -i <path_to_installation_package> # this probably fails with missing dependencies
# apt-get install -f # should install the missing dependencies
# dpkg -i <path_to_installation_package>
```

```bash
$ sudo dnf localinstall odoo_16.0.latest.noarch.rpm
$ sudo systemctl enable odoo
$ sudo systemctl start odoo
```

--------------------------------

### Run Odoo server with CLI arguments

Source: https://www.odoo.com/documentation/16.0/developer/howtos/website_themes/setup.html

A shell script example demonstrating how to launch the Odoo server with specific addons paths, database filters, and development flags.

```bash
./odoo-bin --addons-path=../enterprise,addons --db-filter=<database> -d <database> --without-demo=all -i website --dev=xml
```

--------------------------------

### Install web_enterprise module from source

Source: https://www.odoo.com/documentation/16.0/administration/on_premise/community_to_enterprise.html

Command to install the web_enterprise module when running Odoo from source code.

```bash
$ -d <database_name> -i web_enterprise --stop-after-init
```

--------------------------------

### Declare Actions and Menus

Source: https://www.odoo.com/documentation/16.0/developer/tutorials/backend.html

Example of defining a window action and linking it to a menu item.

```xml
<record model="ir.actions.act_window" id="action_list_ideas">
    <field name="name">Ideas</field>
    <field name="res_model">idea.idea</field>
    <field name="view_mode">tree,form</field>
</record>
<menuitem id="menu_ideas" parent="menu_root" name="Ideas" sequence="10"
          action="action_list_ideas"/>
```

--------------------------------

### Install Odoo Module

Source: https://www.odoo.com/documentation/16.0/administration/odoo_sh/advanced/containers.html

Install a specific module without demo data and exit immediately after completion.

```bash
$  odoo-bin -i sale --without-demo=all --stop-after-init
```

--------------------------------

### Install Odoo via Repository

Source: https://www.odoo.com/documentation/16.0/administration/on_premise/packages.html

Commands to add the Odoo nightly repository and install the Community edition.

```bash
$ 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/16.0/nightly/deb/ ./' | sudo tee /etc/apt/sources.list.d/odoo.list
$ sudo apt-get update && sudo apt-get install odoo
```

```bash
$ sudo dnf config-manager --add-repo=https://nightly.odoo.com/16.0/nightly/rpm/odoo.repo
$ sudo dnf install -y odoo
$ sudo systemctl enable odoo
$ sudo systemctl start odoo
```

--------------------------------

### Count lines using configuration file

Source: https://www.odoo.com/documentation/16.0/developer/reference/cli.html

Use a configuration file to define the addons path for database analysis.

```bash
$ odoo-bin cloc -c config.conf -d my_database
```

--------------------------------

### Importing core utilities

Source: https://www.odoo.com/documentation/16.0/developer/reference/frontend/framework_overview.html

Use the @web prefix to import modules from the web/static/src directory.

```javascript
import { memoize } from "@web/core/utils/functions";
```
Tokens:
Raw