Book Image

Odoo 12 Development Cookbook - Third Edition

By : Parth Gajjar, Alexandre Fayolle, Holger Brunn, Daniel Reis

Book Image

Odoo 12 Development Cookbook - Third Edition

By: Parth Gajjar, Alexandre Fayolle, Holger Brunn, Daniel Reis

Overview of this book

Odoo is a powerful framework known for rapid application development. Its latest release, Odoo 12, introduces tons of new features. With this book, you’ll learn how to develop powerful Odoo applications from scratch, using all the latest features. This Odoo cookbook starts by covering Odoo installation and deployment on the server. Next, you’ll explore the Odoo framework with real-world examples. You’ll create a new Odoo module from the ground up and progress to advanced framework concepts. You’ll also learn how to modify existing applications, including Point of Sale (POS). This book is not just limited to backend development; the advanced JavaScript recipes for creating new views and widgets will help you build beautiful UI elements. As you move forward, you’ll gain insights into website development and become a quality Odoo developer by studying performance optimization, debugging, and automated tests. Finally, you’ll learn the latest concepts like multi-website, In-App Purchasing (IAP), Odoo.sh, and IoT Box. By the end of the book, you’ll have all the knowledge you need to build powerful Odoo applications. The development best practices used in this book will undoubtedly come handy when you are working with the Odoo framework.

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 a 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 add-ons path

Updating the add-on modules list

Standardizing your instance directory layout

Installing and upgrading local add-on modules

Installing add-on modules from GitHub

Applying changes to add-ons

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 Docker to run Odoo

Running Odoo through docker-compose

Managing content delivery networks for websites

Creating Odoo Add-On Modules

Creating Odoo Add-On Modules

Technical requirements

Creating and installing a new add-on module

Completing the add-on module manifest

Organizing the add-on module file structure

Adding menu items and views

Adding access security

Using the scaffold command to create a module

Application Models

Application Models

Technical requirements

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

Technical requirements

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

Sorting recordsets

Extending the business logic defined in a model

Extending write() and create()

Customizing how records are searched

Fetching data in groups with read_group()

Module Data

Technical requirements

Using external IDs and namespaces

Loading data using XML files

Using the noupdate and forcecreate flags

Loading data using CSV files

Add-on updates and data migration

Deleting records from XML files

Invoking functions from XML files

Debugging

The auto-reload and --dev options

Producing server logs to help debug methods

Using the Odoo shell to interactively call methods

Using the Python debugger to trace method execution

Using the Odoo Community Association maintainer quality tools

Understanding the debug mode options

Advanced Server-Side Development Techniques

Advanced Server-Side Development Techniques

Technical requirements

Changing the user that performs 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 an SQL view

Adding custom settings options

Implementing init hooks

Backend Views

Technical requirements

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

Defining list views

Defining search views

Changing existing views – view inheritance

Defining document-style forms

Dynamic form elements using attrs

Defining embedded views

Displaying attachments on the side of the form view

Defining kanban views

Showing kanban cards in columns according to their state

Defining calendar and gantt views

Defining graph and pivot views

Defining the cohort view

Defining the dashboard view

Access Security

Access Security

Technical requirements

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

Accessing recordsets as a superuser

Hiding view elements and menus based on groups

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 make translations easier

Importing translation files into Odoo

Automation, Workflows, and Printouts

Automation, Workflows, and Printouts

Technical requirements

Managing dynamic record stages

Managing kanban stages

Adding a quick create form in a kanban card

Creating interactive kanban cards

Adding a progress bar in kanban views

Creating server actions

Using Python code server actions

Using automated actions on time conditions

Using automated actions on event conditions

Creating QWeb-based PDF reports

Web Server Development

Web Server Development

Technical requirements

Making a path accessible from the network

Restricting access to web accessible paths

Consuming parameters passed to your handlers

Modifying an existing handler

CMS Website Development

CMS Website Development

Managing static assets

Extending CSS and JavaScript for the website

Creating or modifying templates – QWeb

Managing dynamic routes

Offering snippets to the user

Getting input from users

Managing Search Engine Optimization (SEO) options

Managing sitemaps for the website

Getting a visitor's country information

Tracking a marketing campaign

Managing multiple websites

Web Client Development

Web Client Development

Technical requirements

Creating custom widgets

Using client-side QWeb templates

Making RPC calls to the server

Creating a new view

Debugging your client-side code

Improving onboarding with tour

Mobile app JavaScript

In-App Purchasing with Odoo

In-App Purchasing with Odoo

Technical requirements

In-app purchase concepts

Registering an IAP service in Odoo

Creating an IAP service module

Authorizing and charging IAP credits

Creating an IAP client module

Displaying offers when an account lacks credits

Automated Test Cases

Automated Test Cases

Technical requirements

Python test cases

Running tagged Python test cases

Setting up Headless Chrome for client-side test cases

Client-side QUnit test cases

Adding tour test cases

Running client-side test cases from the UI

Debugging client-side test cases

Generating videos/screenshots for failed test cases

Managing, Deploying, and Testing with Odoo.sh

Managing, Deploying, and Testing with Odoo.sh

Technical requirements

Exploring some basic concepts of Odoo.sh

Creating an Odoo.sh account

Adding and installing custom modules

Managing branches

Accessing debugging options

Getting a backup of your instance

Checking the status of your builds

All Odoo.sh options

Remote Procedure Calls in Odoo

Remote Procedure Calls in Odoo

Technical requirements

Logging in/connecting Odoo with XML-RPC

Searching/reading records through XML-RPC

Creating/updating/deleting records through XML-RPC

Calling methods through XML-RPC

Logging in/connecting Odoo with JSON-RPC

Fetching/searching records through JSON-RPC

Create/update/delete records through JSON-RPC

Calling methods through JSON-RPC

The OCA odoorpc library

Performance Optimization

Performance Optimization

The prefetching pattern for the recordsets

The in-memory cache – ormcache

Generating image thumbnails

Accessing grouped data

Creating or writing multiple records

Accessing records through database queries

Profiling Python code

Point of Sale

Technical requirements

Adding custom JavaScript/SCSS files

Adding an action button on the keyboard

Making RPC calls

Modifying the POS screen UI

Modifying existing business logic

Modifying customer receipts

Manage Emails in Odoo

Manage Emails in Odoo

Technical requirements

Configuring incoming and outgoing mail servers

Managing chatter on documents

Managing activities on documents

Sending mail using the Jinja template

Sending mail using the QWeb template

Managing the mail alias

Logging user changes in chatter

IoT Box

Technical requirements

Flashing the IoT Box image for Raspberry Pi

Connecting the IoT Box with the network

Adding the IoT Box to Odoo

Loading drivers and listing connected devices

Taking input from devices

Accessing the IoT Box through SSH

Configuring a point of sale

Other Book You May Enjoy

Other Book 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

Introduction

Odoo's web client, or backend, is where employees spend most of their time. In Chapter 10, Backend Views, you saw how to use the existing possibilities that backends offer. Here, we'll take a look at how to extend and customize those possibilities. The web module contains everything related to the user interface in Odoo.

All of the code in this chapter will depend on the web module. As you know, Odoo has two different editions (Enterprise and Community). Community uses the web module for user interfaces, while the Enterprise version uses an extended version of the Community web module, which is the web_enterprise module.

The Enterprise version provides some extra features over the Community web, such as mobile compatibility, searchable menus, material design, and so on. We'll work on the Community edition here. Don't worry—the modules developed...