Odoo Docker

This repo contains the nessecary Dockerfiles needed for Odoo. Our chosen solution for the HRWhitelisting Project.

What is Odoo

Odoo is an open source web-based ERP (Enterprise Resource System) built primarly on the Python programming language and PostgreSQL database. Odoo is highly cuhstomizable and configurable through its interface or through the use of modules. You can find more information on Odoo here.

How to get Odoo running locally

We are using Docker and docker-compose for the core system and mounting custom plugins by copying them from the add-ons. This includes modules/apps as well as themes

We are using the Stock Odoo 13.0 Docker image which you can find more info on on DockerHub and on github

Setting up for development

You should use the Odoo stock image for local development as you are able to easily reload changes to modules

Step 1. Start the containers using docker-compose

docker-compose up

Step 2. Create the database and your admin credentials. The database name can be whatever you want it to be. For the email, it does not need to actually be an email. You can enter a simple user name like odoo. Be sure to remember what you set for your email and password fields as this will be your login information.

Step 3. Install the HR Module.

Go to apps and clear the apps filter

Step 4. Search hr_mod and press enter and install the module that appears.

Step 5. Activate developer mode by going to general settings

You should now be ready to develop modules

To take down Odoo completely, i.e. restart from scratch

# ctrl + C first if you are in the same shell
$ docker-compose down

To stop Odoo and continue where you left off later

# or ctrl + C if you are in the same shell
$ docker-compose stop

Reloading changes

Step 1. Make sure your code is saved to disk

Step 2. Within the Apps module, update app list from Odoo ( activate developer mode if you do not see this )

Step 5. Find your module and upgrade it

Your changes should now be reflected

Note that if you make changes to python files, you will need to restart the server. To do this simply stop the containers by either ctrl + C if you are in the same shell, or docker-compose stop. Then start the containers back up again and upgrade your module with the altered code.

Creating Modules

As stated, almost all Odoo configuration is done through modules. In this way Odoo can almost be infinitely extended.

To get started learning how to build modules, go through this tutorial. Note: There is already an open academy module for you to play around with. Be sure to create a new branch id you decide to modify for learning purposes

Some Notes That May Help You

A couple of things to note that aren't explicitly mentioned in the tutorial. When creating data files in XML, you are actually creating records for different tables in the database.

For example take a look at openacademy.xml and specifically at this piece

<!--course list view-->
<record model="ir.ui.view" id="course_tree_view">
    <field name="name">course.tree</field>
    <field name="model">openacademy.course</field>
    <field name="arch" type="xml">
        <tree string="Course Tree">
            <field name = "name" />
            <field name = "responsible_id" />
        </tree>
    </field>
</record>

It's pretty intuitive, we are creating a record for the ir.ui.view table ( ir_ui_view in PostgreSQL ) and populating the record with its fields. In this case we are creating a list view for courses based off of the openacademy.course model ( go through the tutorial at least once to understand what I am talking about).

As such you are able to use modules to overwrite data for other modules!

For example, we are using the employees module in Odoo. However, we found it was very clutered with a lot of unnecessary views. For example the kanban views for Departments and Employees. Our users are more familiar with an excel like interface, so we want to remove this view.

Here is the code for the entire employees module on github.

The view for departments is represented by the hr_departments_views.xml

This view defines three views. To see the full code, look at hr_departments_views.xml linked above

The kanban view

<record id="hr_department_view_kanban" model="ir.ui.view" >
    <field name="name">hr.department.kanban</field>
    <field name="model">hr.department</field>
    <field name="arch" type="xml">
        ...
    </field>
</record>

The tree view

<record id="view_department_tree" model="ir.ui.view">
    <field name="name">hr.department.tree</field>
    <field name="model">hr.department</field>
    <field name="arch" type="xml">
        <tree string="Companies">
            <field name="display_name"/>
            <field name="company_id" groups="base.group_multi_company"/>
            <field name="manager_id"/>
            <field name="parent_id"/>
        </tree>
    </field>
</record>

The form view

<record id="view_department_form" model="ir.ui.view">
    <field name="name">hr.department.form</field>
    <field name="model">hr.department</field>
    <field name="arch" type="xml">
        <form string="department">
            <sheet>
                <widget name="web_ribbon" title="Archived" bg_color="bg-danger" attrs="{'invisible': [('active', '=', True)]}"/>
                <field name="active" invisible="1"/>
                <group col="4">
                    <field name="name"/>
                    <field name="manager_id"/>
                    <field name="parent_id"/>
                    <field name="company_id" options="{'no_create': True}" groups="base.group_multi_company"/>
                </group>
            </sheet>
            <div class="oe_chatter">
                <field name="message_follower_ids" widget="mail_followers" groups="base.group_user"/>
                <field name="message_ids" widget="mail_thread"/>
            </div>
        </form>
    </field>
</record>

These views all get combined in a window which defines the Department page in the employees module

<record id="open_module_tree_department" model="ir.actions.act_window">
        <field name="name">Departments</field>
        <field name="res_model">hr.department</field>
        <field name="view_mode">kanban,tree,form</field>
        <field name="search_view_id" ref="view_department_filter"/>
        <field name="help" type="html">
            <p class="o_view_nocontent_smiling_face">
            Create a new department
            </p><p>
            Odoo's department structure is used to manage all documents
            related to employees by departments: expenses, timesheets,
            leaves, recruitments, etc.
            </p>
        </field>
    </record>
</data>

The view_mode field is specifically what enables or disables certain views. As you can see we need to remove the kanban view from our view_mode

<field name="view_mode">kanban,tree,form</field>

The way this works is that the xml will be parsed by Odoo and the kanban view will be resolved to the record hr_department_view_kanban. We can reference this record globally ( from other modules )by using something called the External ID. This is in the format of <module_name>.<record_id>, so for our kanban view it would be hr.hr_department_view_kanban for example.

In order to modify the departments page to remove the kanban view we created a new module hr_modifier that overrides the open_module_tree_department window record. You can see the file here.

<?xml version="1.0" encoding="utf-8"?>
<odoo>
    <data>
      <record id="hr.open_module_tree_department" model="ir.actions.act_window">
          <field name="name">Departments</field>
          <field name="res_model">hr.department</field>
          <field name="view_mode">tree,form</field>
          <field name="search_view_id" ref="hr.view_department_filter"/>
          <field name="view_ids" eval="[(5, 0, 0), (0, 0, {'view_mode': 'tree', 'view_id': ref('hr.view_department_tree')}), (0, 0, {'view_mode': 'form', 'view_id': ref('hr.view_department_form')})]"/>
          <field name="help" type="html">
            <p class="o_view_nocontent_smiling_face">
              Create a new department
            </p><p>
              Odoo's department structure is used to manage all documents
              related to employees by departments: expenses, timesheets,
              leaves, recruitments, etc.
            </p>
          </field>
      </record>
    </data>
</odoo>

Take a close look at the id for this record

<record id="hr.open_module_tree_department" model="ir.actions.act_window">

We are using the External ID for the Department window view. When the hr_modifier module is installed it will overwrite that window record in the database and thus removing the ability to select the kanban view !