Browse Library
Sign In Start Free Trial
Close icon Search icon
Account
Browse Library Advanced Search Sign In Start Free Trial

Add to playlist

Create a Playlist

Modal Close icon
You need to login to use this feature.
  • Book Overview & Buying Odoo Development Cookbook
  • Table Of Contents Toc
  • Feedback & Rating feedback
Odoo Development Cookbook

Odoo Development Cookbook

By : Daudi, Vora, Gajjar, Fayolle, Holger Brunn, Daniel Reis
4.2 (12)
Buy this Book
close
close
Odoo Development Cookbook

Odoo Development Cookbook

4.2 (12)
By: Daudi, Vora, Gajjar, Fayolle, Holger Brunn, Daniel Reis
Buy this Book

Overview of this book

The latest version of the powerful Odoo framework uncovers a wide variety of features for rapid application development. Written by seasoned Odoo experts, this updated Odoo Development Cookbook will help you explore Odoo 17’s new features and use them to develop applications from scratch. You'll learn about website development concepts and get to grips with the Odoo Web Library (OWL), as well as create a new Odoo module from the ground up before progressing to advanced framework concepts. The book also shows you how to modify existing applications, including Point of Sale (POS) applications. Going beyond backend development, you'll discover advanced JavaScript recipes for creating new views and widgets. You'll get a clear understanding of website development and be on your way to becoming a proficient Odoo developer by studying performance optimization, debugging, and automated testing. By the end of this book, you'll have the knowledge you need to build impressive applications and be well-versed in Odoo development best practices.
Table of Contents (28 chapters)
close
close
close
Preface
Icon
Preface
Icon
Who this book is for
Icon
What this book covers
Icon
To get the most out of this book
Icon
Download the example code files
Icon
Conventions used
Icon
Sections
Icon
Get in touch
Icon
Share your thoughts
Icon
Download a free PDF copy of this book
Free Chapter
1
Chapter 1: Installing the Odoo Development Environment
Icon
Chapter 1: Installing the Odoo Development Environment
Icon
Technical requirements
Icon
Understanding the Odoo ecosystem
Icon
Installing Odoo from the source
Icon
Managing Odoo server databases
Icon
Storing the instance configuration in a file
Icon
Activating Odoo developer tools
Icon
Updating the add-on modules list
2
Chapter 2: Managing Odoo Server Instances
chevron up
Icon
Chapter 2: Managing Odoo Server Instances
Icon
Configuring the add-ons path
Icon
Standardizing your instance directory layout
Icon
Installing and upgrading local add-on modules
Icon
Installing add-on modules from GitHub
Icon
Applying changes to add-ons
Icon
Applying and trying proposed PRs
3
Chapter 3: Creating Odoo Add-On Modules
Icon
Chapter 3: Creating Odoo Add-On Modules
Icon
Technical requirements
Icon
What is an Odoo add-on module?
Icon
Creating and installing a new add-on module
Icon
Completing the add-on module manifest
Icon
Organizing the add-on module file structure
Icon
Adding models
Icon
Adding access security
Icon
Adding menu items and views
Icon
Using the scaffold command to create a module
4
Chapter 4: Application Models
Icon
Chapter 4: Application Models
Icon
Technical requirements
Icon
Defining the model representation and order
Icon
Adding data fields to a model
Icon
Adding a float field with configurable precision
Icon
Adding a monetary field to a model
Icon
Adding relational fields to a model
Icon
Adding a hierarchy to a model
Icon
Adding constraints validations to a model
Icon
Adding computed fields to a model
Icon
Exposing related fields stored in other models
Icon
Adding dynamic relations using reference fields
Icon
Adding features to a model using inheritance
Icon
Copying the model definition using inheritance
Icon
Using delegation inheritance to copy features to another model
Icon
Using abstract models for reusable model features
5
Chapter 5: Basic Server-Side Development
Icon
Chapter 5: Basic Server-Side Development
Icon
Technical requirements
Icon
Specifying model methods and using API decorators
Icon
Reporting errors to the user
Icon
Obtaining an empty recordset for a different model
Icon
Creating new records
Icon
Updating values of recordset records
Icon
Searching for records
Icon
Combining recordsets
Icon
Filtering recordsets
Icon
Traversing recordset relations
Icon
Sorting recordsets
Icon
Extending the business logic defined in a model
Icon
Extending write() and create()
Icon
Customizing how records are searched
Icon
Fetching data in groups using read_group()
6
Chapter 6: Managing Module Data
Icon
Chapter 6: Managing Module Data
Icon
Technical requirements
Icon
Using external IDs and namespaces
Icon
Loading data using XML files
Icon
Using the noupdate and forcecreate flags
Icon
Loading data using CSV files
Icon
Add-on updates and data migration
Icon
Deleting records from XML files
Icon
Invoking functions from XML files
7
Chapter 7: Debugging Modules
Icon
Chapter 7: Debugging Modules
Icon
The auto-reload and --dev options
Icon
Producing server logs to help debug methods
Icon
Using the Odoo shell to interactively call methods
Icon
Using the Python debugger to trace method execution
Icon
Understanding the debug mode options
8
Chapter 8: Advanced Server-Side Development Techniques
Icon
Chapter 8: Advanced Server-Side Development Techniques
Icon
Technical requirements
Icon
Changing the user that performs an action
Icon
Calling a method with a modified context
Icon
Executing raw SQL queries
Icon
Writing a wizard to guide the user
Icon
Defining onchange methods
Icon
Calling onchange methods on the server side
Icon
Defining onchange with the compute method
Icon
Defining a model based on a SQL view
Icon
Adding custom Settings options
Icon
Implementing init hooks
9
Chapter 9: Backend Views
Icon
Chapter 9: Backend Views
Icon
Technical requirements
Icon
Adding a menu item and window actions
Icon
Having an action open a specific view
Icon
Adding content and widgets to a form view
Icon
Adding buttons to forms
Icon
Passing parameters to forms and actions – context
Icon
Defining filters on record lists – domain
Icon
Defining list views
Icon
Defining search views
Icon
Adding a search filter side panel
Icon
Changing existing views – view inheritance
Icon
Defining document-style forms
Icon
Dynamic form elements using attributes
Icon
Defining embedded views
Icon
Displaying attachments on the side of the form view
Icon
Defining kanban views
Icon
Showing kanban cards in columns according to their state
Icon
Defining calendar views
Icon
Defining graph view and pivot view
Icon
Defining the cohort view
Icon
Defining the gantt view
Icon
Defining the activity view
Icon
Defining the map view
10
Chapter 10: Security Access
Icon
Chapter 10: Security Access
Icon
Technical requirements
Icon
Creating security groups and assigning them to users
Icon
Adding security access to models
Icon
Limiting access to fields in models
Icon
Limiting record access using record rules
Icon
Activating features with security groups
Icon
Accessing recordsets as a superuser
Icon
Hiding view elements and menus based on groups
11
Chapter 11: Internationalization
Icon
Chapter 11: Internationalization
Icon
Setting up a language installation and user preference settings
Icon
Setting up options relating to language
Icon
Text translation using a web client user interface
Icon
Exporting translation strings to a file
Icon
Using gettext tools to make translations easier
Icon
Importing translation files into Odoo
Icon
Altering a website’s custom language URL code
12
Chapter 12: Automation, Workflows, Emails, and Printing
Icon
Chapter 12: Automation, Workflows, Emails, and Printing
Icon
Technical requirements
Icon
Managing dynamic record stages
Icon
Managing Kanban stages
Icon
Adding a quick create form to a Kanban card
Icon
Creating interactive Kanban cards
Icon
Adding a progress bar to Kanban views
Icon
Creating server actions
Icon
Using Python code server actions
Icon
Using automated actions on time conditions
Icon
Using automated actions on event conditions
Icon
Creating QWeb-based PDF reports
Icon
Managing activities from a Kanban card
Icon
Adding a stat button to a form view
Icon
Enabling the archive option for records
13
Chapter 13: Web Server Development
Icon
Chapter 13: Web Server Development
Icon
Technical requirements
Icon
Restricting access to web-accessible paths
Icon
Consuming parameters passed to your handlers
Icon
Modifying an existing handler
Icon
Serving static resources
14
Chapter 14: CMS Website Development
Icon
Chapter 14: CMS Website Development
Icon
Managing assets
Icon
Adding CSS and JavaScript for a website
Icon
Creating or modifying templates
Icon
Managing dynamic routes
Icon
Offering static snippets to the user
Icon
Offering dynamic snippets to the user
Icon
Getting input from website users
Icon
Managing SEO options
Icon
Managing sitemaps for the website
Icon
Getting a visitor’s country information
Icon
Tracking a marketing campaign
Icon
Managing multiple websites
Icon
Redirecting old URLs
Icon
Publish management for website-related records
15
Chapter 15: Web Client Development
Icon
Chapter 15: Web Client Development
Icon
Technical requirements
Icon
Creating custom widgets
Icon
Using client-side QWeb templates
Icon
Making RPC calls to the server
Icon
Creating a new view
Icon
Debugging your client-side code
Icon
Improving onboarding with tours
Icon
Mobile app JavaScript
16
Chapter 16: The Odoo Web Library (OWL)
Icon
Chapter 16: The Odoo Web Library (OWL)
Icon
Technical requirements
Icon
Creating an OWL component
Icon
Managing user actions in an OWL component
Icon
Making OWL components with hooks
Icon
Understanding the OWL component life cycle
Icon
Adding an OWL field to the form view
17
Chapter 17: In-App Purchasing with Odoo
Icon
Chapter 17: In-App Purchasing with Odoo
Icon
IAP concepts
Icon
Odoo IAP
18
Chapter 18: Automated Test Cases
Icon
Chapter 18: Automated Test Cases
Icon
Technical requirements
Icon
Adding Python test cases
Icon
Running tagged Python test cases
Icon
Setting up Headless Chrome for client-side test cases
Icon
Adding client-side QUnit test cases
Icon
Adding tour test cases
Icon
Running client-side test cases from the UI
Icon
Debugging client-side test cases
Icon
Generating videos/screenshots for failed test cases
Icon
Populating random data for testing
19
Chapter 19: Managing, Deploying, and Testing with Odoo.sh
Icon
Chapter 19: Managing, Deploying, and Testing with Odoo.sh
Icon
Exploring some basic concepts of Odoo.sh
Icon
Creating an Odoo.sh account
Icon
Adding and installing custom modules
Icon
Managing branches
Icon
Accessing debugging options
Icon
Getting a backup of your instance
Icon
Checking the status of your builds
Icon
All Odoo.sh options
20
Chapter 20: Remote Procedure Calls in Odoo
Icon
Chapter 20: Remote Procedure Calls in Odoo
Icon
Technical requirements
Icon
Logging in to/connecting Odoo with XML-RPC
Icon
Searching/reading records using XML-RPC
Icon
Creating/updating/deleting records using XML-RPC
Icon
Calling methods using XML-RPC
Icon
Logging in to/connecting Odoo with JSON-RPC
Icon
Fetching/searching records using JSON-RPC
Icon
Creating/updating/deleting records using JSON-RPC
Icon
Calling methods using JSON-RPC
Icon
The OCA odoorpc library
Icon
Generating API keys
21
Chapter 21: Performance Optimization
Icon
Chapter 21: Performance Optimization
Icon
The prefetching pattern for recordsets
Icon
The in-memory cache – ormcache
Icon
Generating images in different size
Icon
Accessing grouped data
Icon
Creating or writing multiple records
Icon
Accessing records through database queries
Icon
Profiling
22
Chapter 22: Point of Sale
Icon
Chapter 22: Point of Sale
Icon
Technical requirements
Icon
Adding custom JavaScript/SCSS files
Icon
Adding an action button to the keyboard
Icon
Making RPC calls
Icon
Modifying the Point of Sale screen UI
Icon
Modifying existing business logic
Icon
Modifying customer receipts
23
Chapter 23: Managing Emails in Odoo
Icon
Chapter 23: Managing Emails in Odoo
Icon
Technical requirements
Icon
Configuring incoming and outgoing email servers
Icon
Managing chatter on documents
Icon
Managing activities on documents
Icon
Sending emails using the Jinja template
Icon
Sending emails using the QWeb template
Icon
Managing the email alias
Icon
Logging user changes in a chatter
Icon
Sending periodic digest emails
24
Chapter 24: Managing the IoT Box
Icon
Chapter 24: Managing the IoT Box
Icon
Technical requirements
Icon
Flashing the IoT Box image for Raspberry Pi
Icon
Connecting the IoT Box with a network
Icon
Adding the IoT Box to Odoo
Icon
Loading drivers and listing connected devices
Icon
Taking input from devices
Icon
Accessing the IoT Box through SSH
Icon
Configuring a POS
Icon
Sending PDF reports directly to a printer
25
Chapter 25: Web Studio
Icon
Chapter 25: Web Studio
Icon
Installing Odoo Web Studio
Icon
Suggested features
Icon
Components
Icon
Field properties
Icon
Views
Icon
Building a new app
Icon
Customizing an existing app
Icon
Built-in functions
Icon
Reports
26
Index
Icon
Index
Icon
Why subscribe?
27
Other Books You May Enjoy
Icon
Other Books You May Enjoy
Icon
Packt is searching for authors like you
Icon
Share your thoughts
Icon
Download a free PDF copy of this book

Installing add-on modules from GitHub

GitHub is a great source of third-party add-ons. A lot of Odoo partners use GitHub to share the add-ons they maintain internally, and the Odoo Community Association (OCA) collectively maintains several hundred add-ons on GitHub. Before you start writing your own add-on, ensure you check that nothing already exists that you can use as is or as a starting point.

This recipe will show you how to clone the partner-contact project of the OCA from GitHub and make the add-on modules it contains available in your instance.

Getting ready

Suppose you want to add new fields to the customer (partner) form. By default, the Odoo customer model doesn’t have a gender field. If you want to add a gender field, you need to create a new module. Fortunately, someone on a mailing list tells you about the partner_contact_gender add-on module, which is maintained by the OCA as part of the partner-contact project.

The paths that are used in this recipe...

Unlock full access

Continue reading for free

A Packt free trial gives you instant online access to our library of over 7000 practical eBooks and videos, constantly updated with the latest in tech
Start a 7-day FREE trial
End of Section 5
Next Section

Create a Note

Modal Close icon
You need to login to use this feature.
notes
bookmark search playlist download
font-size

Change the font size

margin-width

Change margin width

day-mode

Change background colour

Close icon Search
Country selected
Close icon Your notes and bookmarks

Delete Bookmark

Modal Close icon
Are you sure you want to delete it?
Cancel
Yes, Delete

Delete Note

Modal Close icon
Are you sure you want to delete it?
Cancel
Yes, Delete

Confirmation

Modal Close icon
claim successful
Order Page Read Now

Buy this book with your credits?

Modal Close icon
Are you sure you want to buy this book with one of your credits?
Close
YES, BUY