Odoo

https://www.odoo.com/documentation/
Admin
Odoo is an all-in-one suite of open-source business management software, covering ERP, CRM,...
Tokens:762,310
Snippets:12,130
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Upgrade utils with odoo-bin

Source: https://www.odoo.com/documentation/saas-19.3/developer/reference/upgrades/upgrade_utils.html

Clone the repository and prepend its 'src' directory to the `--upgrade-path` option when starting the Odoo server.

```bash
./odoo-bin --upgrade-path=/path/to/upgrade-util/src,/path/to/other/upgrade/script/directory [...]
```

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

### Create Custom Model and Get Fields

Source: https://www.odoo.com/documentation/saas-19.3/developer/reference/external_rpc_api.html

Demonstrates creating a new custom model and then retrieving its field information using the `ir.model` object. Ensure the model name starts with 'x_' and the state is 'manual'.

```Python
models.execute_kw(db, uid, password, 'ir.model', 'create', [{
    'name': "Custom Model",
    'model': "x_custom_model",
    'state': 'manual',
}])
models.execute_kw(db, uid, password, 'x_custom_model', 'fields_get', [], {'attributes': ['string', 'help', 'type']})
```

```PHP
$models->execute_kw($db, $uid, $password, 'ir.model', 'create', array(array(
    'name' => "Custom Model",
    'model' => 'x_custom_model',
    'state' => 'manual'
)));
$models->execute_kw($db, $uid, $password, 'x_custom_model', 'fields_get', array(), array('attributes' => array('string', 'help', 'type')))
```

```Ruby
models.execute_kw(db, uid, password, 'ir.model', 'create', [{
    name: "Custom Model",
    model: 'x_custom_model',
    state: 'manual'
}])
fields = models.execute_kw(db, uid, password, 'x_custom_model', 'fields_get', [], {attributes: %w(string help type)})
```

```Java
models.execute_kw(
    "execute_kw", asList(
        db, uid, password,
        "ir.model", "create",
        asList(new HashMap<String, Object>() {{ 
            put("name", "Custom Model");
            put("model", "x_custom_model");
            put("state", "manual");
        }})
));
final Object fields = models.execute(
    "execute_kw", asList(
        db, uid, password,
        "x_custom_model", "fields_get",
        emptyList(),
        new HashMap<String, Object> () {{ 
            put("attributes", asList(
                    "string",
                    "help",
                    "type"));
        }}
));
```

```Go
var id int64
if err := models.Call("execute_kw", []any{
    db, uid, password,
    "ir.model", "create",
    []map[string]string{
        {
            "name":  "Custom Model",
            "model": "x_custom_model",
            "state": "manual",
        },
    },
}, &id); err != nil {
    log.Fatal(err)
}
recordFields := map[string]string{}
if err := models.Call("execute_kw", []any{
    db, uid, password,
    "x_custom_model", "fields_get",
    []any{},
    map[string][]string{
        "attributes": {"string", "help", "type"},
    },
}, &recordFields); err != nil {
    log.Fatal(err)
}
```

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

### Get Start of Time Period

Source: https://www.odoo.com/documentation/saas-19.3/developer/reference/backend/orm.html

Calculate the start of a specified time period (year, quarter, month, week, day, or hour) from a given date or datetime object.

```python
fields.Date.start_of(value, granularity)
```

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

### Initialize a Database

Source: https://www.odoo.com/documentation/saas-19.3/developer/reference/cli.html

Creates a new database and installs the `base` module. You can specify the language and country of the main company, and optionally install demo data or force overwriting an existing database.

```bash
$ odoo-bin db init <database>

```

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

### Install Upgrade utils with pip

Source: https://www.odoo.com/documentation/saas-19.3/developer/reference/upgrades/upgrade_utils.html

Install the library directly from its GitHub repository using pip.

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

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

### Force Upgrade of Freshly Installed Module

Source: https://www.odoo.com/documentation/saas-19.3/developer/reference/upgrades/upgrade_utils.html

Use `force_upgrade_of_fresh_module` to ensure upgrade scripts run for a module being installed. This is particularly useful when a new module needs to perform setup operations, such as data migration from other modules.

```python
util.force_upgrade_of_fresh_module(_cr_ , _module_ , _init =True_)
```

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

### Using Delegation Inheritance

Source: https://www.odoo.com/documentation/saas-19.3/developer/reference/backend/orm.html

Shows creating a Laptop record and accessing fields from its delegated Screen and Keyboard models, demonstrating composition.

```python
record = env['delegation.laptop'].create({
    'screen_id': env['delegation.screen'].create({'size': 13.0}).id,
    'keyboard_id': env['delegation.keyboard'].create({'layout': 'QWERTY'}).id,
})
record.size
record.layout
```

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

### Get Server Version

Source: https://www.odoo.com/documentation/saas-19.3/developer/reference/external_rpc_api.html

Examples for retrieving the Odoo server version using the XML-RPC common API endpoint.

```APIDOC
## Get Server Version

### Description
Fetch the Odoo server version information without requiring authentication.

### Method
POST (implicitly via XML-RPC call)

### Endpoint
`{url}/xmlrpc/2/common`

### Parameters
None explicitly documented for the `version` method itself, parameters are passed within the XML-RPC payload.

### Request Example (Python)
```python
import xmlrpc.client
common = xmlrpc.client.ServerProxy('{url}/xmlrpc/2/common')
common.version()
```

### Response
#### Success Response (200)
Returns a dictionary with server version details:
- **server_version** (string) - The main version number (e.g., "13.0").
- **server_version_info** (list) - Detailed version information (e.g., `[13, 0, 0, "final", 0]`).
- **server_serie** (string) - The series of the server (e.g., "13.0").
- **protocol_version** (integer) - The XML-RPC protocol version supported.

#### Response Example
```json
{
    "server_version": "13.0",
    "server_version_info": [13, 0, 0, "final", 0],
    "server_serie": "13.0",
    "protocol_version": 1
}
```
```

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

### Register a JavaScript Tour

Source: https://www.odoo.com/documentation/saas-19.3/developer/reference/backend/testing.html

Register a new tour with a unique name and specify the starting URL. This is the initial setup for a frontend test tour.

```javascript
import tour from 'web_tour.tour';
tour.register('rental_product_configurator_tour', {
    url: '/web',  // Here, you can specify any other starting url
}, [
    // Your sequence of steps
]);
```

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

### Map View Example

Source: https://www.odoo.com/documentation/saas-19.3/developer/reference/user_interface/view_architectures.html

This example demonstrates how to configure a map view, specifying the partner many2one field, default order, routing behavior, and fields to display in the popup.

```xml
<map res_partner="partner_id" default_order="date_begin" routing="ordered" hide_name="1">
    <field name="partner_id" string="Customer Name"/>
</map>

```

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

### Odoo Configuration File Example

Source: https://www.odoo.com/documentation/saas-19.3/developer/reference/cli.html

A sample Odoo configuration file demonstrating how to set database user and filter options.

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

```

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

### Get Test Database Connection Details

Source: https://www.odoo.com/documentation/saas-19.3/developer/reference/external_rpc_api.html

Obtain connection details for a test Odoo database. These examples use different XML-RPC libraries for each language.

```Python
import xmlrpc.client
info = xmlrpc.client.ServerProxy('https://demo.odoo.com/start').start()
url, db, username, password = info['host'], info['database'], info['user'], info['password']

```

```Ruby
require "xmlrpc/client"
info = XMLRPC::Client.new2('https://demo.odoo.com/start').call('start')
url, db, username, password = info['host'], info['database'], info['user'], info['password']

```

```PHP
require_once('ripcord.php');
$info = ripcord::client('https://demo.odoo.com/start')->start();
list($url, $db, $username, $password) = array($info['host'], $info['database'], $info['user'], $info['password']);

```

```Java
final XmlRpcClient client = new XmlRpcClient();

final XmlRpcClientConfigImpl start_config = new XmlRpcClientConfigImpl();
start_config.setServerURL(new URL("https://demo.odoo.com/start"));
final Map<String, String> info = (Map<String, String>)client.execute(
    start_config, "start", emptyList());

final String url = info.get("host"),
              db = info.get("database"),
        username = info.get("user"),
        password = info.get("password");

```

```Go
client, err := xmlrpc.NewClient("https://demo.odoo.com/start", nil)
if err != nil {
    log.Fatal(err)
}
info := map[string]string{}
client.Call("start", nil, &info)
url = info["host"].(string)
db = info["database"].(string)
username = info["user"].(string)
password = info["password"].(string)

```

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

### Clone Odoo Addons Repository

Source: https://www.odoo.com/documentation/saas-19.3/administration/odoo_sh/create_module.html

Clone the Odoo addons repository to your local machine to start module development. Ensure you have a Git client installed.

```bash
mkdir ~/src
cd ~/src
git clone https://github.com/odoo/odoo-addons.git
cd ~/src/odoo-addons
```

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

### Using Extension Inheritance

Source: https://www.odoo.com/documentation/saas-19.3/developer/reference/backend/orm.html

Demonstrates creating a record using extension inheritance and reading its fields, showing how added fields are present.

```python
record = env['extension.0'].create({})
record.read()[0]
```

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

### Start a Tour from a Python Test

Source: https://www.odoo.com/documentation/saas-19.3/developer/reference/backend/testing.html

Initiates an Odoo tour from a Python test case by inheriting from HTTPCase and calling start_tour. Optional setup and verifications can be included.

```python
def test_your_test(self):
    # Optional Setup
    self.start_tour("/web", "your_tour_name", login="admin")
    # Optional verifications
```

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

### Example upgrade script for code migration

Source: https://www.odoo.com/documentation/saas-19.3/developer/reference/cli.html

An example Python script demonstrating how to use the `file_manager` to replace content within files during code upgrades.

```python
def upgrade(file_manager):
    files = (file for file in file_manager if file.path.suffix == '.py')
    for fileno, file in enumerate(files, start=1):
        file.content = file.content.replace(..., ...)
        file_manager.print_progress(fileno, len(files))
```

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

### Example BuilderSelectItem Configuration

Source: https://www.odoo.com/documentation/saas-19.3/developer/howtos/website_themes/theming.html

This snippet shows an example of a `BuilderSelectItem` component, which might be used to configure website options through `actionParam`.

```javascript
<BuilderSelectItem
   id="'...'".
   title.translate="..."
   actionParam=[
      {
         action: 'websiteConfig',
         actionParam: {
             views: [...],
             vars: { 'header-template': 'sidebar' },
             checkVars: false,
         }
      }
   ]>
   <Img src="'/website_airproof/static/src/img/wbuilder/template-header-opt.svg'" class="'mw-100'" />
</BuilderSelectItem>

```

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

### Start Tour with Watch Mode

Source: https://www.odoo.com/documentation/saas-19.3/developer/reference/backend/testing.html

Use `watch=True` to automatically open a Chrome window and run the tour locally. This is useful for tours with Python setup or multiple steps.

```python
self.start_tour("/web", "your_tour_name", watch=True)

```

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

### Clone Petstore Module

Source: https://www.odoo.com/documentation/saas-19.3/developer/tutorials/web.html

Use this command to download the example module for customizing the Odoo web client.

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

```

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

### Configure Detailed Tax Report Lines and Columns

Source: https://www.odoo.com/documentation/saas-19.3/developer/howtos/accounting_localization.html

This example demonstrates the detailed configuration of a tax report, including multi-language names for the report and its columns, setting availability conditions, and defining the report's columns and lines with specific aggregation formulas and expressions. It's used for advanced tax reporting setups.

```xml
    <record id="tax_report" model="account.report">
        <field name="name">Tax Report</field>
        <field name="name@de">Steuerbericht</field>
        <field name="root_report_id" ref="account.generic_tax_report"/>
        <field name="country_id" ref="base.at"/>
        <field name="allow_foreign_vat" eval="True"/>
        <field name="availability_condition">country</field>
        <field name="column_ids">
            <record id="tax_report_balance" model="account.report.column">
                <field name="name">Base</field>
                <field name="name@de">Bemessungsgrundlage</field>
                <field name="expression_label">base</field>
            </record>
            <record id="tax_report_vat" model="account.report.column">
                <field name="name">VAT</field>
                <field name="name@de">Umsatzsteuer</field>
                <field name="expression_label">vat</field>
            </record>
        </field>
        <field name="line_ids">
            <record id="tax_report_line_l10n_at_non_tva_sale_report_title" model="account.report.line">
                <field name="name">3. Breakdown for the recapitulative statement (ZM)</field>
                <field name="name@de">3. Aufschlüsselung für die Zusammenfassende Meldung (ZM)</field>
                <field name="sequence" eval="5"/>
                <field name="aggregation_formula">AT_ZM_IGL.base + AT_ZM_IGL3.base + AT_ZM_DL.base</field>
                <field name="children_ids">
                    <record id="tax_report_line_l10n_at_tva_line_3_zm_igl" model="account.report.line">
                        <field name="name">Intra-Community supplies</field>
                        <field name="name@de">Innergemeinschaftliche Lieferungen</field>
                        <field name="code">AT_ZM_IGL</field>
                        <field name="expression_ids">
                            <record id="tax_report_line_l10n_at_tva_line_3_zm_igl_tag" model="account.report.expression">
                                <field name="label">base</field>
                                <field name="engine">tax_tags</field>
                                <field name="formula">-AT_ZM_IGL</field>
                            </record>
                        </field>
                        <field name="sequence" eval="10"/>
                    </record>

```

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

### Wizard File Naming Example

Source: https://www.odoo.com/documentation/saas-19.3/contributing/development/coding_guidelines.html

Wizard files (transient models) and their associated views should follow the convention `<transient>.py` and `<transient>_views.xml`, respectively, and be placed in the `wizard/` directory.

```directory structure
addons/plant_nursery/
|-- wizard/
|   |-- make_plant_order.py
|   |-- make_plant_order_views.xml
```
Tokens:
Raw