Odoo Development Cookbook

Odoo Development Cookbook

By : Holger Brunn, Alexandre Fayolle, Daniel Reis

Buy this Book

Odoo Development Cookbook

By: Holger Brunn, Alexandre Fayolle, Daniel Reis

Buy this Book

Overview of this book

Odoo is a full-featured open source ERP with a focus on extensibility. The flexibility and sustainability of open source is also a key selling point of Odoo. It is built on a powerful framework for rapid application development, both for back-end applications and front-end websites. The book starts by covering Odoo installation and administration, and provides a gentle introduction to application development. It then dives deep into several of the areas that an experienced developer will need to use. You’ll learn implement business logic, adapt the UI, and extend existing features.

Odoo Development Cookbook

Credits

About the Authors

About the Reviewers

www.PacktPub.com

Preface

Free Chapter

Installing the Odoo Development Environment

Introduction

Easy installation of Odoo from source

Managing Odoo environments using the start command

Managing Odoo server databases

Storing the instance configuration in a file

Activating the Odoo developer tools

Updating Odoo from source

Managing Odoo Server Instances

Introduction

Configuring the addons path

Updating the addon modules list

Standardizing your instance directory layout

Installing and upgrading local addon modules

Installing addon modules from GitHub

Applying changes to addons

Applying and trying proposed pull requests

Creating Odoo Modules

Introduction

Creating and installing a new addon module

Completing the addon module manifest

Organizing the addon module file structure

Adding models

Adding Menu Items and Views

Using scaffold to create a module

Application Models

Introduction

Defining the Model representation and order

Adding data fields to a model

Using a float field with configurable precision

Adding a monetary field to a Model

Adding relational fields to a Model

Adding a hierarchy to a Model

Adding constraint validations to a Model

Adding computed fields to a Model

Adding dynamic relations using Reference fields

Adding features to a Model using inheritance

Using Abstract Models for reusable Model features

Using Delegation inheritance to copy features to another Model

Basic Server Side Development

Introduction

Defining model methods and use the API decorators

Reporting errors to the user

Obtaining an empty recordset for a different model

Creating new records

Updating values of recordset records

Searching for records

Combining recordsets

Filtering recordsets

Traversing recordset relations

Extending the business logic defined in a Model

Extending write() and create()

Customizing how records are searched

Advanced Server Side Development Techniques

Introduction

Change the user performing an action

Call a method with a modified context

Execute raw SQL queries

Write a wizard to guide the user

Define onchange methods

Call onchange methods on the server side

Port old API code to the new API

Debugging and Automated Testing

Introduction

Producing server logs to help debug methods

Using the Odoo shell to interactively call methods

Using the Python debugger to trace method execution

Writing tests for your module using YAML

Writing tests for your module using Python unit tests

Running server tests

Using the Odoo Community Association maintainer quality tools

Backend Views

Introduction

Adding a menu item and window action

Having an action open a specific view

Adding content and widgets to a form view

Adding buttons to forms

Passing parameters to forms and actions: Context

Defining filters on record lists: Domain

List views

Search views

Changing existing views: View inheritance

Document-style forms

Dynamic form elements using attrs

Embedded views

Kanban views

Show kanban cards in columns according to their state

Calendar views

Graph and pivot views

QWeb reports

Module Data

Introduction

Using external IDs and namespaces

Loading data using XML files

Using the noupdate and forcecreate flags

Loading data using CSV files

Loading data using YAML files

Addon updates and data migration

Access Security

Create security groups and assign them to users

Add security access to models

Limit access to fields in models

Limit record access using record rules

Using security group to activate features

Internationalization

Installing a language and configure user preferences

Configure language-related settings

Translate texts through the web client user interface

Exporting translation strings to a file

Use gettext tools to ease translations

Import translation files

Automation and Workflows

Introduction

Using Kanban stages and features

Creating server actions

Adding messaging and tracking features

Using Python code server actions

Using automated actions on time conditions

Using automated actions on event conditions

Inspecting built-in workflows

Web Server Development

Introduction

Make a path accessible from the network

Restrict access to web accessible paths

Consume parameters passed to your handlers

Modify an existing handler

Using the RPC API

CMS Website Development

Introduction

Extending CSS and JavaScript for the website

Creating or modifying templates - QWeb

Offering snippets to the user

Web Client Development

Introduction

Creating custom widgets

Using client-side QWeb templates

Making RPC calls to the server

Writing tests for client side code

Debugging your client side code

Server Deployment

Introduction

Installing Odoo for production

Adapting the configuration file for production

Set up Odoo as a system service

Configure a reverse proxy and SSL

Use buildout for repeatable builds

Index

Customer Reviews

5 star

4 star

3 star

2 star

1 star

Updating Odoo from source

We saw in the first recipe how to install Odoo from source by using the git repository. The main benefit of this setting is being able to update the source code of Odoo using git to get the latest bug fixes.

Getting ready

Stop any instance currently running with the Odoo source you are about to update.

Make a backup of all the databases you care about in case something goes bad. This is obviously something you need to do for production databases. See the Managing Odoo server databases recipe for instructions.

Then make a note of the current version of the source you are running. The best way is to create a lightweight tag using the following command:

$ cd ~/odoo-dev/odoo
$ git checkout 9.0
$ git tag 9.0-before-update-$(date --iso)

How to do it...

To update the source code of Odoo, use the following command:

$ git pull –-ff-only

This will fetch the latest version of the source code committed to the current branch.

To update an instance running on this code, run the following command:

$ odoo.py -c myodoo.cfg --stop-after-init -u base

Note

-u is the shortcut notation for the --update option of odoo.py.

If you don't have a database set in the configuration file, you will have to add the -d database_name option. That command is to be repeated for all the instances running with this version of the source code.

If the update fails, don't panic, you have backups.

Read the error message carefully. Save it to a file, as it will be useful to make a bug report later.
If you cannot figure out what the problem is, restore the service; restore the Odoo source code to the previous version, which is known to work using the tag you set before updating the source version:
```
$ git reset --hard 9.0-before-update-$(date --iso)
```
Drop the broken databases and restore them from the backups you made (see the Managing Odoo server databases recipe for instructions).
Restart your instances and tell your users that the upgrade has been postponed.

Note

Note that in real life, this should never happen on a production database, because you would have tested the upgrade beforehand on a copy of the database, fixed the issues, and only done the upgrade on the production server after making sure that it runs flawlessly. But sometimes, you still get surprises, so even if you are really sure, make a backup.

How it works...

Updating the source code is done by making sure we are on the correct branch using git checkout, and then fetching the new revisions using git pull. The --ff-only option will cause a failure if you have local commits not present in the remote repository. If this happens and you want to keep your changes, you can use git pull (without --ff-only) to merge the remote changes with yours; otherwise, use git reset --hard origin/9.0 to force the update, discarding your local modifications.

The update command uses the following options:

-c: specify the configuration file
--stop-after-init: stop the instance when the update is over
-u base or --update base: requests the update of the base module

When updating a module, Odoo does the following:

It updates the database structure for the models defined in the module for which the structure changes. For updates on the stable branch of Odoo, there should be no such changes, but this can happen for your own addons or third party addons.
It updates the database records stored in data files of the module, most notably the views. It then recursively updates the installed modules which have declared a dependency on the module.

Since the base module is an implicit dependency of all Odoo modules, updating it will trigger an update of all the installed modules in your instance. To update all installed modules, the alias all can be used instead of base.

Odoo Development Cookbook

By : Holger Brunn, Alexandre Fayolle, Daniel Reis

Odoo Development Cookbook

By: Holger Brunn, Alexandre Fayolle, Daniel Reis

Overview of this book

Related Content you might be interested in

Current Title:

Odoo Development Cookbook

Updating Odoo from source

Getting ready

How to do it...

Note

Note

How it works...