README.rst

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.

Table of contents

• Configuration
• Usage
  • Using the Interface
  • Creating an Adapter
• Bug Tracker
• Credits
  • Authors
  • Contributors
  • Maintainers

Configuration

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

Usage

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.

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

Authors

• LasLabs

Contributors

• Dave Lasley <[email protected]>
• Alexandre Díaz <[email protected]>

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.