Skip to main content
License: LGPL-3

Base - External System

This module provides an interface/adapter mechanism for the definition of remote systems.

Note that this module stores everything in plain text. In the interest of security, it is recommended you use another module (such as keychain or red_october to encrypt things like the password and private key). This is not done here in order to not force a specific security method.

Implementation

The credentials for systems are stored in the external.system model, and are to be configured by the user. This model is the unified interface for the underlying adapters.

Using the Interface

Given an external.system singleton called external_system, you would do the following to get the underlying system client:

with external_system.client() as client:
    client.do_something()

The client will be destroyed once the context has completed. Destruction takes place in the adapter’s external_destroy_client method.

The only unified aspect of this interface is the client connection itself. Other more opinionated interface/adapter mechanisms can be implemented in other modules, such as the file system interface in OCA/server-tools/external_file_location.

Creating an Adapter

Modules looking to add an external system adapter should inherit the external.system.adapter model and override the following methods:

  • external_get_client: Returns a usable client for the system

  • external_destroy_client: Destroy the connection, if applicable. Does not need to be defined if the connection destroys itself.

Configuration

Configure external systems in Settings => Technical => External Systems

Try me on Runbot

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 smash it by providing detailed and welcomed feedback.

Credits

Images

  • Odoo Community Association: Icon.

Contributors

Maintainer

Odoo Community Association

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.

To contribute to this module, please visit https://odoo-community.org.

Metadata

Release files for odoo11-addon-base-external-system 11.0.1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for odoo11-addon-base-external-system 11.0.1.0.0
File Interpreter ABI Platform Actions
odoo11_addon_base_external_system-11.0.1.0.0-py2.py3-none-any.whl Python 2, Python 3 none any Details for odoo11_addon_base_external_system-11.0.1.0.0-py2.py3-none-any.whl

Release files / odoo11_addon_base_external_system-11.0.1.0.0-py2.py3-none-any.whl

Download URL odoo11_addon_base_external_system-11.0.1.0.0-py2.py3-none-any.whl
Size 26.8 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
8944e8fe5946804e157198a0930137db675adc1c93ecb422c620185709e41184
BLAKE2b-256 checksum
How to use checksums
52602ae427c07d7f110c5383edbd3d68a2786a238d25d2220e67caf8a8fd3099
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for odoo11-addon-base-external-system 11.0.1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page