odoo-configurator 3.0.1

Configure and update Odoo database with YAML files

odoo-configurator

Update Odoo database with YAML files

Installation

pip install odoo-configurator

Usage

odoo-configurator ./work_dir/cutomer_name.local.yml

Provided file must contain the auth/odoo section to set connexion parameters.

name.local.yml

---
name: cutomer_name local

inherits:
    - ../work_dir/cutomer_name/cutomer_name.yml

auth:
    odoo:
        url: http://cutomer_name.localhost
        dbname: cutomer_name
        username: admin
        password: admin123

Inherits

Inherits param provide a list of configuration files witch content is merged before execution.

inherits:
    - ../work_dir/cutomer_name/sales.yml
    - ../work_dir/cutomer_name/account.yml

Script Files

Script Files param provide a list of configuration files witch content will be executed sequentially.

script_files:
    - ../work_dir/cutomer_name/script1.yml
    - ../work_dir/cutomer_name/script2.yml

Parameters

Install Mode: To import datas with the value on_install_only: True add the "--install" parameter in command line:

./start_config.py ./clients/name/name.local.yml --install

Pre Update

To prepare a configuration or add a fix use "pre_update", the given scripts will be executed before the normal configuration.

pre_update:
    - ../exemple/exemple.pre_update_script.yml

Modules

To install modules use "modules"

base:
  modules:
    - example_module

To update modules use "updates"

base:
  updates:
    - example_module

To uninstall modules use "uninstall_modules"

base:
  uninstall_modules:
    - example_module

Set config parameters (Settings)

to set the value of a setting (res.config.settings)

settings:
  config:
    group_use_lead: True

For a specific company:

settings main_company:
  config:
    company_id: get_ref("base.main_company")
    chart_template_id: get_ref("l10n_fr.l10n_fr_pcg_chart_template")

Update data

You can update values on a model according to a domain with "update_domain":

Update Example:
  model: res.partner
  update_domain: "[('email','=','[e-mail]')]"
  values:
    name: Example

Server Actions and Functions

To call a model function:

001 Call Function:
  datas:
    Call Function:
      function: example_function
      model: res.parnter
      res_id: get_ref("base.partner_demo")
      params: ['param1', param2]
      kw: {'extra_param1': get_ref('external_config.extra_param1')}  

To call an action server:

002 Call Action Server:
  datas:
    Call Action Server:
      action_server_id: get_ref("custom_module.action_exemple")
      model: res.parnter
      res_id: get_ref("base.partner_demo")

Users

To set groups on a user you can remove previous groups with "unlink all":

users:
    datas:
        User Example:
            model: res.users
            force_id: base.user_example
            values:
                name: Example
                login: [e-mail]
            groups_id:
                - unlink all
                - base.group_portal

Other data tools

• delete_all
• delete_domain
• delete_id
• deactivate
• activate
• update_domain
• search_value_xml_id

  • this option allows to pass an id from xml_id to a domain

  • Can be used with update_domain, activate, deactivate:

        Deactivate Partner Title doctor:
            model: res.partner.title
            search_value_xml_id: base.res_partner_title_doctor
            deactivate: "[('id', '=', search_value_xml_id)]"
    

Translations

To set the translation of a translatable field, use the languages option. Example:

Mail Templates:
    datas:
        Notification:
            model: mail.template
            force_id: mail.notification_template
            languages:
                - fr_FR
                - en_US
            values:
                body_html: |
                    <table>
                        <tbody>
                        Text for french and english
                        </tbody>
                    </table>

Mattermost Notification

To set a Mattermost url and channel where to send notifications:

mattermost_channel: my-channel
mattermost_url: https://mattermost.xxx.com/hooks/dfh654fgh

To avoid Mattermost notification, add in main yaml file:

no_notification: True

Keepass

Keepass is a tool to store and protect passwords.

Available functions to use stored values in Configurator:

get_keepass_password('path/passwords.kdbx', 'Folder Name', 'Key Name')
get_keepass_user('path/passwords.kdbx', 'Folder Name', 'Key Name')
get_keepass_url('path/passwords.kdbx', 'Folder Name', 'Key Name')

Provide Keepass password with this parameter in command line: --keepass='mdp***'

Standard CSV Import

Columns in the CSV file must be the technical name of the field. A column "id" is required to allow update of datas.

In yml file:

import_data:
    import_csv Product Template:
        on_install_only: True
        model: product.template
        name_create_enabled_fields: uom_id,uom_po_id,subscription_template_id
        file_path: ../datas/todoo/product.template.csv
        specific_import: base/import_specific.py
        specific_method: import_partner
        batch_size: 200
        skip_line: 1420
        limit: 100
        context: {'install_mode': True}

Required fields:

• model
• file_path

Optional fields:

• name_create_enabled_fields : List of the fields which are allowed to "Create the record if it doesn't exist"
• on_install_only : Do the csv export only in Install Mode
• context : Provide a specific context for imports
• specific_import : Path to a specific Python file
• specific_method : Import method to use form the file specific_import
• batch_size : Number of records by load batch
• limit : Maximum number of record to import
• skip_line : index of the record to start with

Contributors

• David Halgand
• Michel Perrocheau - Github

Maintainer

This module is maintained by Hodei.