Book Image

Odoo 14 Development Cookbook - Fourth Edition

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

5 (2)

Book Image

Odoo 14 Development Cookbook - Fourth Edition

5 (2)

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

Overview of this book

With its latest iteration, the powerful Odoo framework released a wide variety of features for rapid application development. This updated Odoo development cookbook will help you explore the new features in Odoo 14 and learn how to use them to develop Odoo applications from scratch. You'll learn about the new website concepts in Odoo 14 and get a glimpse of Odoo's new web-client framework, the Odoo Web Library (OWL). Once you've completed the installation, you'll begin to explore the Odoo framework with real-world examples. You'll then 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) applications. This book isn't just limited to backend development; you'll discover advanced JavaScript recipes for creating new views and widgets. As you progress, you'll learn about website development and become a quality Odoo developer by studying performance optimization, debugging, and automated testing. Finally, you'll delve into advanced concepts such as multi-website, In-App Purchasing (IAP), Odoo.sh, the IoT Box, and security. By the end of the book, you'll have all the knowledge you need to build impressive Odoo applications and you'll be well versed in development best practices that will come in handy when working with the Odoo framework.

Preface

Who this book is for

What this book covers

To get the most out of this book

Download the example code files

Download the color images

Conventions used

Chapter 1: Installing the Odoo Development Environment

Chapter 1: Installing the Odoo Development Environment

Understanding the Odoo ecosystem

Easy installation of Odoo from source

Managing Odoo server databases

Storing the instance configuration in a file

Activating Odoo developer tools

Updating the add-on modules list

Free Chapter

Chapter 2: Managing Odoo Server Instances

Chapter 2: Managing Odoo Server Instances

Configuring the add-ons path

Standardizing your instance directory layout

How to do it…

How it works…

Installing and upgrading local add-on modules

Installing add-on modules from GitHub

Applying changes to add-ons

Applying and trying proposed pull requests

Chapter 3: Creating Odoo Add-On Modules

Chapter 3: Creating Odoo Add-On Modules

Technical requirements

What is an Odoo add-on module?

Creating and installing a new add-on module

How to do it...

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

Chapter 4: Application Models

Chapter 4: 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

Copy model definition using inheritance

Using delegation inheritance to copy features to another model

Using abstract models for reusable model features

Chapter 5: Basic Server-Side Development

Chapter 5: Basic Server-Side Development

Technical requirements

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

Chapter 6: Managing Module Data

Chapter 6: Managing 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

Chapter 7: Debugging Modules

Chapter 7: Debugging Modules

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

Understanding the debug mode options

Chapter 8: Advanced Server-Side Development Techniques

Chapter 8: 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 onchange with the compute method

Defining a model based on a SQL view

Adding custom settings options

Implementing init hooks

Chapter 9: Backend Views

Chapter 9: Backend Views

Technical requirements

Adding a menu item and window actions

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

Adding a search filter side panel

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 views

Defining graph view and pivot view

Defining the cohort view

Defining the dashboard view

Defining the gantt view

Defining the activity view

Defining the map view

Chapter 10: Security Access

Chapter 10: Security Access

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

Chapter 11: Internationalization

Chapter 11: 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

Changing the custom language URL code for a website

Chapter 12: Automation, Workflows, Emails, and Printing

Chapter 12: Automation, Workflows, Emails, and Printing

Technical requirements

Managing dynamic record stages

Managing kanban stages

Adding a quick create form to 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

Managing activities from a kanban card

Adding a stat button to a form view

Enabling the archive option for records

Chapter 13: Web Server Development

Chapter 13: 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

Serving static resources

Chapter 14: CMS Website Development

Chapter 14: CMS Website Development

Managing static assets

Adding CSS and JavaScript for a website

Creating or modifying templates – QWeb

Managing dynamic routes

Offering static snippets to the user

Offering dynamic snippets to the user

Getting input from website users

Managing SEO options

Managing sitemaps for the website

Getting a visitor's country information

Tracking a marketing campaign

Managing multiple websites

Redirecting old URLs

Publish management for website-related records

Chapter 15: Web Client Development

Chapter 15: 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 tours

Mobile app JavaScript

Chapter 16: The Odoo Web Library (OWL)

Chapter 16: The Odoo Web Library (OWL)

Technical requirements

Creating an OWL component

Managing user actions in an OWL component

Making OWL components reactive

Understanding the OWL component life cycle

Adding an OWL field to the form view

Chapter 17: In-App Purchasing with Odoo

Chapter 17: In-App Purchasing with Odoo

Technical requirements

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

Chapter 18: Automated Test Cases

Chapter 18: Automated Test Cases

Technical requirements

Adding Python test cases

Running tagged Python test cases

Setting up Headless Chrome for client-side test cases

Adding 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

Populating random data for testing

Chapter 19: Managing, Deploying, and Testing with Odoo.sh

Chapter 19: 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

Chapter 20: Remote Procedure Calls in Odoo

Chapter 20: Remote Procedure Calls in Odoo

Technical requirements

Logging in to/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 to/connecting Odoo with JSON-RPC

Fetching/searching records through JSON-RPC

Creating/updating/deleting records through JSON-RPC

Calling methods through JSON-RPC

The OCA odoorpc library

Generating API keys

Chapter 21: Performance Optimization

Chapter 21: Performance Optimization

The prefetching pattern for recordsets

The in-memory cache – ormcache

Generating differently sized images

Accessing grouped data

Creating or writing multiple records

Accessing records through database queries

Profiling Python code

Chapter 22: Point of Sale

Chapter 22: Point of Sale

Technical requirements

Adding custom JavaScript/SCSS files

Adding an action button on the keyboard

Making RPC calls

Modifying the Point of Sale screen UI

Modifying existing business logic

Modifying customer receipts

Chapter 23: Managing Emails in Odoo

Chapter 23: Managing Emails in Odoo

Technical requirements

Configuring incoming and outgoing email servers

Managing chatter on documents

Managing activities on documents

Sending emails using the Jinja template

Sending emails using the QWeb template

Managing the email alias

Logging user changes in a chatter

Sending periodic digest emails

Chapter 24: Managing the IoT Box

Chapter 24: Managing the IoT Box

Technical requirements

Flashing the IoT Box image for Raspberry Pi

Connecting the IoT Box with a 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

Sending PDF reports directly to a printer

Other Books You May Enjoy

Other Books You May Enjoy

Leave a review - let other readers know what you think

Customer Reviews

5 (2)

5 star

100%

4 star

0

3 star

0

2 star

0

1 star

0

Managing sitemaps for the website

A website's sitemaps are crucial for any website. The search engine will use website sitemaps to index the pages of a website. In this recipe, we will add book details pages to the sitemap.

Getting ready...

For this recipe, we will be using the my_library module from the previous recipe. If you want to check the current sitemap in Odoo, open <your_odoo_server_url>/sitemap.xml in your browser. This will not have the book's URL in it.

How to do it...

Follow these steps to add a book's page to sitemap.xml:

Import the methods in main.py, as follows:

from odoo.addons.http_routing.models.ir_http import slug
from odoo.addons.website.models.ir_http import sitemap_qs2dom

Add the sitemap_books method to main.py, as follows:

class Main(http.Controller):
...
    def sitemap_books(env, rule, qs):
        Books = env['library.book']
   ...