book

Odoo Development Cookbook - Fifth Edition

Name: Odoo Development Cookbook - Fifth Edition
ISBN: 9781805124276

by Husen Daudi, Jay Vora, Parth Gajjar, Alexandre Fayolle, Holger Brunn, Daniel Reis

May 2024

Intermediate to advanced

774 pages

17h 58m

English

Packt Publishing

Read now

Unlock full access

Odoo Development Cookbook
ContributorsAbout the authorsThank you noteAbout the reviewer
Preface
Who this book is forWhat this book coversTo get the most out of this bookDownload the example code filesConventions usedSectionsGetting readyHow to do it…How it works…There’s more…See alsoGet in touchShare your thoughtsDownload a free PDF copy of this book
Chapter 1: Installing the Odoo Development Environment
Technical requirementsUnderstanding the Odoo ecosystemOdoo editionsGit repositoriesRunbotOdoo app storeOdoo Community AssociationOfficial Odoo help forumOdoo’s eLearning platformInstalling Odoo from the sourceGetting readyHow to do it...How it works...Starting the instanceManaging Odoo server databasesGetting readyHow to do it...How it works...There’s more...Storing the instance configuration in a fileHow to do it...How it works...Activating Odoo developer toolsHow to do it...How it works...Updating the add-on modules listGetting readyHow to do it…How it works…
Chapter 2: Managing Odoo Server Instances
Configuring the add-ons pathGetting readyHow to do it…How it works…There’s more…Standardizing your instance directory layoutHow to do it…How it works…There’s more...Installing and upgrading local add-on modulesGetting readyHow to do it…How it works…There’s more…Installing add-on modules from GitHubGetting readyHow to do it…How it works…There’s more…Applying changes to add-onsGetting readyHow to do it…How it works…See alsoApplying and trying proposed PRsGetting readyHow to do it…How it works…There’s more…
Chapter 3: Creating Odoo Add-On Modules
Technical requirementsWhat is an Odoo add-on module?Creating and installing a new add-on moduleGetting readyHow to do it...How it works...Completing the add-on module manifestGetting readyHow to do it...How it works...There’s more…Organizing the add-on module file structureGetting readyHow to do it...How it works...Adding modelsGetting readyHow to do it...How it works...Adding access securityGetting readyHow to do it...How it works…See alsoAdding menu items and viewsGetting readyHow to do it...How it works...Using the scaffold command to create a moduleGetting readyHow to do it...How it works...
Chapter 4: Application Models
Technical requirementsDefining the model representation and orderGetting readyHow to do it...There’s more…Adding data fields to a modelGetting readyHow to do it...How it works...There’s more...Adding a float field with configurable precisionGetting readyHow to do it...How it works...Adding a monetary field to a modelGetting readyHow to do it…How it works…Adding relational fields to a modelGetting readyHow to do it...How it works…There’s more...Adding a hierarchy to a modelGetting readyHow to do it...How it works…There’s more…Adding constraints validations to a modelGetting readyHow to do it...How it works…Adding computed fields to a modelGetting readyHow to do it...How it works...There’s more...Exposing related fields stored in other modelsGetting readyHow to do it...How it works...There’s more...Adding dynamic relations using reference fieldsGetting readyHow to do it...How it works...Adding features to a model using inheritanceGetting readyHow to do it...How it works...Copying the model definition using inheritanceGetting readyHow to do it...How it works...There’s more…Using delegation inheritance to copy features to another modelGetting readyHow to do it...How it works...There’s more...Using abstract models for reusable model featuresGetting readyHow to do it...How it works...There’s more...
Chapter 5: Basic Server-Side Development
Technical requirementsSpecifying model methods and using API decoratorsGetting readyHow to do it…How it works…Reporting errors to the userGetting readyHow to do it…How it works…There’s more…Obtaining an empty recordset for a different modelGetting readyHow to do it…How it works…See alsoCreating new recordsGetting readyHow to do it…How it works…There’s more…Updating values of recordset recordsGetting readyHow to do it…How it works…There’s more…Searching for recordsGetting readyHow to do it…How it works…There’s more…Combining recordsetsGetting readyHow to do it…How it works…Filtering recordsetsGetting readyHow to do it…How it works…There’s more…Traversing recordset relationsGetting readyHow to do it…How it works…There’s more…See alsoSorting recordsetsGetting readyHow to do it…How it works…There’s more…Extending the business logic defined in a modelGetting readyHow to do it…How it works…There’s more…Extending write() and create()Getting readyHow to do it…How it works…There’s more…Customizing how records are searchedGetting readyHow to do it…How it works…There’s more…See alsoFetching data in groups using read_group()Getting readyHow to do it…How it works…
Chapter 6: Managing Module Data
Technical requirementsUsing external IDs and namespacesHow to do it...How it works...There’s more…See alsoLoading data using XML filesHow to do it...How it works...There’s more...Using the noupdate and forcecreate flagsHow to do it...How it works...There’s more...See alsoLoading data using CSV filesHow to do it...How it works...Add-on updates and data migrationHow to do it...How it works...There’s more...See alsoDeleting records from XML filesGetting readyHow to do it...How it works...Invoking functions from XML filesHow to do it...How it works...There’s more...
Chapter 7: Debugging Modules
The auto-reload and --dev optionsGetting readyHow to do it...How it works...Producing server logs to help debug methodsGetting readyHow to do it...How it works...There’s more...Using the Odoo shell to interactively call methodsGetting readyHow to do it...How it works...There’s more...Using the Python debugger to trace method executionGetting readyHow to do it...How it works...There’s more...See alsoUnderstanding the debug mode optionsHow to do it...How it works...
Chapter 8: Advanced Server-Side Development Techniques
Technical requirementsChanging the user that performs an actionGetting readyHow to do it...How it works...There’s more...See alsoCalling a method with a modified contextGetting readyHow to do it...How it works…There’s more...See alsoExecuting raw SQL queriesGetting readyHow to do it...How it works...There’s more...See alsoWriting a wizard to guide the userGetting readyHow to do it...How it works...There’s more...Redirecting the userSee alsoDefining onchange methodsGetting readyHow to do it...How it works...There’s more...Calling onchange methods on the server sideGetting readyHow to do it...How it works...See alsoDefining onchange with the compute methodGetting readyHow to do it...How it works...See alsoDefining a model based on a SQL viewGetting readyHow to do it...How it works...There’s more...See alsoAdding custom Settings optionsGetting readyHow to do it...How it works...There’s more...Implementing init hooksGetting readyHow to do it...How it works...

Chapter 9: Backend Views
Technical requirementsAdding a menu item and window actionsGetting readyHow to do it...How it works...There’s more…See alsoHaving an action open a specific viewHow to do it...How it works...There’s more...Adding content and widgets to a form viewHow to do it...How it works...There’s more…See alsoAdding buttons to formsHow to do it...How it works...There’s more...Passing parameters to forms and actions – contextGetting readyHow to do it...How it works...There’s more...See alsoDefining filters on record lists – domainHow to do it...How it works...There’s more...See alsoDefining list viewsHow to do it...How it works...There’s more...Defining search viewsHow to do it...How it works...There’s more...See alsoAdding a search filter side panelGetting readyHow to do it...How it works...There’s more...Changing existing views – view inheritanceHow to do it...How it works...There’s more...Defining document-style formsHow to do it...How it works...See alsoDynamic form elements using attributesHow to do it...How it works...There’s more...Defining embedded viewsHow to do it...How it works...There’s more...Displaying attachments on the side of the form viewHow to do it...How it works...There’s more...Defining kanban viewsHow to do it...How it works...There’s more...See alsoShowing kanban cards in columns according to their stateGetting readyHow to do it...How it works...There’s more...Defining calendar viewsHow to do it...How it works...There’s more...Defining graph view and pivot viewGetting readyHow to do it...How it works...There’s more...Defining the cohort viewGetting readyHow to do it...How it works...Defining the gantt viewGetting readyHow to do it...How it works...There’s more...Defining the activity viewGetting readyHow to do it...How it works...Defining the map viewGetting readyHow to do it…How it works...
Chapter 10: Security Access
Technical requirementsCreating security groups and assigning them to usersGetting readyHow to do it...How it works...There’s more...See alsoAdding security access to modelsGetting readyHow to do it...How it works...There’s more...See alsoLimiting access to fields in modelsGetting readyHow to do it...How it works...There’s more...See alsoLimiting record access using record rulesGetting readyHow to do it...How it works...There’s more...Activating features with security groupsGetting readyHow to do it...How it works...There’s more...Accessing recordsets as a superuserHow to do it...How it works...There’s more...Hiding view elements and menus based on groupsGetting readyHow to do it...How it works...See also
Chapter 11: Internationalization
Setting up a language installation and user preference settingsHow to do it…How it works...There’s more...Setting up options relating to languageGetting readyHow to do it...How it works...There’s more...Text translation using a web client user interfaceGetting readyHow to do it...How it works…Exporting translation strings to a fileGetting readyHow to do it…How it works...There’s more…Using gettext tools to make translations easierHow to do it...How it works...There’s more...Importing translation files into OdooGetting readyHow to do it...How it works...Altering a website’s custom language URL codeGetting readyHow to do it...How it works...
Chapter 12: Automation, Workflows, Emails, and Printing
Technical requirementsManaging dynamic record stagesGetting readyHow to do it...How it works...See alsoManaging Kanban stagesGetting startedHow to do it...How it works...There’s more...See alsoAdding a quick create form to a Kanban cardGetting startedHow to do it...How it works...Creating interactive Kanban cardsGetting startedHow to do it...How it works...Adding a progress bar to Kanban viewsGetting startedHow to do it...How it works...Creating server actionsGetting readyHow to do it...How it works...There’s more...Using Python code server actionsGetting readyHow to do it...How it works...There’s more...See alsoUsing automated actions on time conditionsGetting readyHow to do it...How it works...There’s more...See alsoUsing automated actions on event conditionsGetting readyHow to do it...How it works...There’s more...Creating QWeb-based PDF reportsGetting readyHow to do it...How it works...There’s more...Managing activities from a Kanban cardGetting startedHow to do it...How it works...There’s more…See alsoAdding a stat button to a form viewGetting startedHow to do it...How it works...See alsoEnabling the archive option for recordsGetting startedHow to do it...How it works...There’s more…
Chapter 13: Web Server Development
Technical requirementsMaking a path accessible from a networkGetting readyHow to do it...How it works...There’s more...See alsoRestricting access to web-accessible pathsGetting readyHow to do it...How it works...There’s more...Consuming parameters passed to your handlersHow to do it...How it works...There’s more...See alsoModifying an existing handlerGetting readyHow to do it...How it works…There’s more...See alsoServing static resourcesGetting readyHow to do it...How it works…
Chapter 14: CMS Website Development
Managing assetsWhat are asset bundles and different assets in Odoo?Custom assetsHow to do it...There’s more...Adding CSS and JavaScript for a websiteCreating or modifying templatesUnderstanding QWeb templatesCreating a basic website templateUsing Odoo Website BuilderStyling and customizationLoopsDynamic attributesFieldsConditionalsSetting variablesSubtemplatesInline editingManaging dynamic routesGetting readyHow to do it…How it works…There’s more...Offering static snippets to the userHow to do it…How it works…There’s more…Offering dynamic snippets to the userHow to do it…How it works…There’s more…Getting input from website usersGetting readyHow to do it…Managing SEO optionsGetting readyHow to do it...How it works...There’s more...Managing sitemaps for the websiteGetting readyHow to do it...How it works...There’s more...Getting a visitor’s country informationGetting readyHow to do it...How it works...Tracking a marketing campaignGetting readyHow to do it...How it works...Managing multiple websitesGetting readyHow to do it...How it works...Redirecting old URLsGetting readyHow to do it...How it works...Publish management for website-related recordsGetting readyHow to do it…How it works...There’s more…
Chapter 15: Web Client Development
Technical requirementsCreating custom widgetsGetting readyHow to do it…How it works…Using client-side QWeb templatesGetting readyHow to do it...How it works...There’s more…Making RPC calls to the serverGetting readyHow to do it…How it works…See alsoCreating a new viewGetting readyHow to do it…How it works…Debugging your client-side codeGetting readyHow to do it...How it works…There’s more…Improving onboarding with toursGetting readyHow to do it…How it works…Mobile app JavaScriptGetting readyHow to do it…How it works…There’s more...
Chapter 16: The Odoo Web Library (OWL)
Technical requirementsCreating an OWL componentGetting readyHow to do it...How it works...There’s more...Managing user actions in an OWL componentGetting readyHow to do it...How it works…There’s more...Making OWL components with hooksGetting readyHow to do it…How it works...Understanding the OWL component life cycleGetting readyHow to do it…How it works…There’s more…Adding an OWL field to the form viewGetting readyHow to do it…How it works…There’s more…
Chapter 17: In-App Purchasing with Odoo
IAP conceptsOdoo IAPHow it works…
Chapter 18: Automated Test Cases
Technical requirementsAdding Python test casesGetting readyHow to do it...How it works...There’s more...Running tagged Python test casesGetting readyHow to do it...How it works...There’s more...Setting up Headless Chrome for client-side test casesHow to do it...How it works...Adding client-side QUnit test casesGetting readyHow to do it...How it works...There’s more...Adding tour test casesGetting readyHow to do it...How it works...Running client-side test cases from the UIHow to do it...How it works...Debugging client-side test casesGetting readyHow to do it...How it works...Generating videos/screenshots for failed test casesHow to do it...How it works...Populating random data for testingGetting readyHow to do it...How it works...There’s more…
Chapter 19: Managing, Deploying, and Testing with Odoo.sh
Exploring some basic concepts of Odoo.shWhat is Odoo.sh?Why was Odoo.sh introduced?When should you use Odoo.sh?What are the features of Odoo.sh?Creating an Odoo.sh accountGetting readyHow to do it...How it works...There’s more...Adding and installing custom modulesGetting readyHow to do it...How it works...There’s more...Managing branchesGetting readyHow to do it...How it works...Accessing debugging optionsHow to do it...There’s more...Getting a backup of your instanceHow to do it...How it works...Checking the status of your buildsHow to do it...How it works...There’s more...All Odoo.sh optionsGetting readyHow to do it...There’s more...
Chapter 20: Remote Procedure Calls in Odoo
Technical requirementsLogging in to/connecting Odoo with XML-RPCGetting readyHow to do it...How it works...There’s more...Searching/reading records using XML-RPCGetting readyHow to do it...How it works...There’s more...Creating/updating/deleting records using XML-RPCGetting readyHow to do it...How it works...There’s more...Calling methods using XML-RPCGetting readyHow to do it...How it works...There’s more...Logging in to/connecting Odoo with JSON-RPCGetting readyHow to do it...How it works...There’s more...Fetching/searching records using JSON-RPCGetting readyHow to do it...How it works...There’s more...Creating/updating/deleting records using JSON-RPCGetting readyHow to do it...How it works...There’s more...Calling methods using JSON-RPCGetting readyHow to do it...How it works...The OCA odoorpc libraryGetting readyHow to do it...How it works...There’s more...See alsoGenerating API keysHow to do it...How it works…
Chapter 21: Performance Optimization
The prefetching pattern for recordsetsHow to do it…How it works...There’s more...The in-memory cache – ormcacheHow to do it...How it works...There’s more...Generating images in different sizeHow to do it...How it works...There’s more...Accessing grouped dataHow to do it...How it works...There’s more...See alsoCreating or writing multiple recordsHow to do it...How it works...There’s more...Accessing records through database queriesHow to do it...How it works...There’s more...ProfilingEnabling the profiler
Chapter 22: Point of Sale
Technical requirementsAdding custom JavaScript/SCSS filesGetting readyHow to do it…How it works…There’s more…Adding an action button to the keyboardGetting readyHow to do it…How it works..There’s more…Making RPC callsGetting readyHow to do it...How it works…There’s more…Modifying the Point of Sale screen UIGetting readyHow to do it…How it works...Modifying existing business logicGetting readyHow to do it…How it works...Modifying customer receiptsGetting readyHow to do it…How it works...
Chapter 23: Managing Emails in Odoo
Technical requirementsConfiguring incoming and outgoing email serversGetting readyHow to do it...How it works...There’s more...Managing chatter on documentsGetting readyHow to do it...How it works...There’s more...Managing activities on documentsGetting readyHow to do it...How it works...There’s more...Sending emails using the Jinja templateGetting readyHow to do it...How it works...There’s more...Sending emails using the QWeb templateGetting readyHow to do it...How it works...There’s more...Managing the email aliasGetting readyHow to do it...How it works...There’s more...Logging user changes in a chatterGetting readyHow to do it...How it works...Sending periodic digest emailsGetting readyHow to do it...How it works...
Chapter 24: Managing the IoT Box
Technical requirementsFlashing the IoT Box image for Raspberry PiGetting readyHow to do it…How it works…There’s more...Connecting the IoT Box with a networkGetting readyHow to do it…How it works...Adding the IoT Box to OdooGetting readyHow to do it…How it works…There’s more…Loading drivers and listing connected devicesGetting readyHow to do it…How it works…Taking input from devicesGetting readyHow to do it…How it works…There’s more…Accessing the IoT Box through SSHGetting readyHow to do it…How it works…There’s more…Configuring a POSGetting readyHow to do it…How it works…There’s more…Sending PDF reports directly to a printerGetting readyHow to do it…How it works…
Chapter 25: Web Studio
Installing Odoo Web StudioStarting with a new appSuggested featuresComponentsField propertiesViewsForm viewsList viewsKanban viewsCalendar viewsGraph viewsPivot viewsSearch viewsGantt viewsResource viewsBuilding a new appDefining the data modelDefining the general viewsDefining the fields and componentsAdding a buttonFiltersEdit MenuCustomizing an existing appChoosing an existing app to customizeBuilt-in functionsImporting modulesExporting modulesSearch viewAutomationsReportsExternal reportsInternal reportsBlank reportsModulesSearch viewsAutomations
Index
Why subscribe?
Other Books You May EnjoyPackt is searching for authors like youShare your thoughtsDownload a free PDF copy of this book

Overview

Discover how to harness the potential of Odoo 17 to create powerful and intuitive business applications. This comprehensive guide takes you through the process of mastering the Odoo framework, from setting up a development environment to building and deploying customized applications.

What this Book will help me do

Build modular and scalable business applications using Odoo.
Optimize your applications with advanced debugging and performance techniques.
Leverage Odoo's CMS for creating dynamic and engaging websites.
Implement in-app purchasing functionalities in your Odoo solutions.
Use the Odoo.sh platform for efficient testing and deployment.

Author(s)

The authors of 'Odoo Development Cookbook' are a group of seasoned developers and practitioners with in-depth expertise in the Odoo framework. They bring together years of experience in developing and customizing Odoo applications for diverse business needs. Their hands-on approach in imparting knowledge ensures that readers can easily apply the concepts shared in real-world scenarios.

Who is it for?

This book is perfect for software developers who are new to Odoo and want to learn how to build effective business applications using its framework. It's also valuable for seasoned Odoo developers seeking to explore the advanced features added in Odoo 17. Prerequisite knowledge includes basic Python and JavaScript programming skills, enabling readers to get the most out of the book.

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.

Julian F.

Head of Cybersecurity

I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.

Addison B.

Field Engineer

I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.

Amir M.

Data Platform Tech Lead

I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.

Mark W.

Embedded Software Engineer

Publisher Resources

ISBN: 9781805124276

Cloud Computing

Data Engineering

Data Science

AI & ML

Programming Languages

Software Architecture

IT/Ops

Security

Design

Business

Soft Skills