Installation

This module requires the Python package odoorpc to be installed in the same environment as your Odoo server.

Install it with pip, for example:

pip install odoorpc

Then install the Odoo module in the Apps menu as usual.

If you run Odoo in Docker or another containerized setup, ensure the dependency is present in the image that runs the Odoo server.

Configuration

1. Go to Settings → External Systems (menu provided by base_external_system).

2. Create a new record.

3. Set System Type to External System RPC (external.system.odoo).

4. Fill in the connection parameters:

   • Host (e.g. odoo-test.odoo.org)

   • Port (e.g. 443 or 8069)

   • Database name

   • Username

   • Password

   • SSL toggle (if applicable)

5. Save the record.

After saving, the adapter interface record is created automatically by base_external_system and is available via the interface field.

Usage

Test connection (UI)

Open an external system record configured with System Type External System RPC and click the Test Connection button.

If successful, the adapter will report success (using the success mechanism provided by base_external_system).

Using the client in code

Use the standard context manager from base_external_system:

system = self.env.ref("your_module.external_system_odoo_remote")
with system.client() as odoo:
    partner_model = odoo.env["res.partner"]
    ids = partner_model.search([("is_company", "=", True)], limit=10)
    data = partner_model.read(ids, ["name"])

The yielded object is an odoorpc.ODOO client instance, so any remote model can be accessed via odoo.env["model.name"].

Legacy helper (optional)

Some projects historically called a helper directly on the adapter record:

odoo = system.interface._connect()

If your adapter keeps that helper for backward compatibility, it returns the same client object as external_get_client().

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Maintainers

This module is maintained by the OCA.

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

This module is part of the OCA/server-backend project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.