Book Image

Odoo 11 Development Cookbook - Second Edition

Book Image

Odoo 11 Development Cookbook - Second Edition

Overview of this book

Odoo is a full-featured open source ERP with a focus on extensibility. The flexibility and sustainability of open source are 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. Version 11 offers better usability and speed: a new design (as compared to the current Odoo Enterprise version) and a mobile interface. The book starts by covering Odoo installation and administration and Odoo Server deployment. It then delves into the implementation of Odoo modules, the different inheritance models available in Odoo. You will then learn how to define access rules for your data; how to make your application available in different languages; how to expose your data models to end users on the back end and on the front end; and how to create beautiful PDF versions of your data. By the end of the book, you will have a thorough knowledge of Odoo and will be able to build effective applications by applying Odoo development best practices

Preface

Who this book is for

What this book covers

To get the most out of this book

Free Chapter

Installing the Odoo Development Environment

Installing the Odoo Development Environment

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

Managing Odoo Server Instances

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

Server Deployment

Server Deployment

Installing Odoo for production use

Adapting the configuration file for production

Setting up Odoo as a system service

Configuring a reverse proxy and SSL with nginx and Let's Encrypt

Using buildout for repeatable builds

Using Docker to run Odoo

Creating Odoo Addon Modules

Creating Odoo Addon Modules

Creating and installing a new addon module

Completing the addon module manifest

Organizing the addon module file structure

Adding Menu Items and Views

Adding Access Security

Using scaffold to create a module

Application Models

Application Models

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

Exposing related fields stored in other Models

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

Basic Server-Side Development

Defining model methods and using 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

Module Data

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

Debugging and Automated Testing

Debugging and Automated Testing

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 Python unit tests

Running server tests

Using the Odoo Community Association maintainer quality tools

Advanced Server-Side Development Techniques

Advanced Server-Side Development Techniques

Changing the user performing an action

Calling a method with a modified context

Executing raw SQL queries

Writing a wizard to guide the user

Defining onchange methods

Calling onchange methods on the server side

Defining a model based on a SQL view

Backend Views

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

Changing existing views – View inheritance

Document-style forms

Dynamic form elements using attrs

Showing kanban cards in columns according to their state

Calendar and gantt views

Graph and pivot views

Access Security

Access Security

Creating security groups and assigning them to users

Adding security access to models

Limiting access to fields in models

Limiting record access using record rules

Using security groups to activate features

Internationalization

Internationalization

Installing a language and configuring user preferences

Configuring language-related settings

Translating texts through the web client user interface

Exporting translation strings to a file

Using gettext tools to ease translations

Importing translation files into Odoo

Automation, Workflows, Emails, and Printouts

Automation, Workflows, Emails, and Printouts

Using Kanban stages and features

Creating server actions

Using Python code server actions

Using automated actions on time conditions

Using automated actions on event conditions

Adding messaging and tracking features

Email templates

QWeb-based PDF reports

Producing LibreOffice-based reports with Py3O

Web Server Development

Web Server Development

Making a path accessible from the network

Restricting access to web accessible paths

Consuming parameters passed to your handlers

Modifying an existing handler

Using the RPC API

Web Client Development

Web Client Development

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

CMS Website Development

CMS Website Development

Extending CSS and JavaScript for the website

Creating or modifying templates – QWeb

Offering snippets to the user

Other Books You May Enjoy

Other Books You May Enjoy

Leave a review - let other readers know what you think

Customer Reviews

5 star

0

4 star

0

3 star

0

2 star

0

1 star

0

Activating the Odoo developer tools

When using Odoo as a developer, you need to know how to activate Developer Mode in the web interface to access the advanced settings menu and developer information.

How to do it...

To activate Developer Mode in the web interface, do as follows:

Connect to your instance and authenticate as admin
Go to the Settings menu
Locate the Share the love card, which should be on the right of the screen:
Click on the Activate the developer mode link

Wait for the UI to reload

It is also possible to activate the developer mode by editing the URL; before the # sign, insert ?debug. For instance, if you are starting from
http://localhost:8069/web#menu_id=102&action=94, then you need to change this to
http://localhost:8069/web?debug=#menu_id=102&action=94.
To exit the developer mode, you can do either of these:

Edit the URL and remove that string
Close your browser tab and open a new one
Use the Deactivate the developer mode link displayed in the Share the love card when the Developer mode is active

How it works...

When in developer mode, two things happen:

You get tooltips when hovering over a field in a form view or over a column in list view, providing technical information about the field (internal name, type, and so on)
A drop-down menu with a Bug icon is displayed next to the user's menu in the top-right corner, giving access to technical information about the model being displayed, the various related view definitions, the workflow, custom filter management, and so on

There is a variant of the developer mode—the Developer mode (with assets). This mode behaves as the normal developer mode, but additionally, the JavaScript and CSS code sent to the browser is not minified, which means that the web development tools of your browser are easy to use for debugging the JavaScript code (more on this in Chapter 15, Web Client Development).

Caution!

Test your addons both with and without developer mode, as the unminified versions of the JavaScript libraries can hide bugs that only bite you in the minified version.