Skip to main content

Provides a base for adding multi-company support to models.

Project description

Production/Stable License: LGPL-3 OCA/multi-company Translate me on Weblate Try me on Runbot

This module provides an abstract model to be inherited by models that need to implement multi-company functionality.

No direct functionality is provided by this module.

Table of contents

Usage

Implementation

Multi Company Abstract

The multi.company.abstract model is meant to be inherited by any model that wants to implement multi-company functionality. The logic does not require a pre-existing company field on the inheriting model, but will not be affected if one does exist.

When inheriting the multi.company.abstract model, you must take care that it is the first model listed in the _inherit array

class ProductTemplate(models.Model):
    _inherit = ["multi.company.abstract", "product.template"]
    _name = "product.template"
    _description = "Product Template (Multi-Company)"

The following fields are provided by multi.company.abstract:

  • company_ids - All of the companies that this record belongs to. This is a special res.company.assignment view, which allows for the circumvention of standard cross-company security policies. These policies would normally restrict a user from seeing another company unless it is currently operating under that company. Be aware of apples to oranges issues when comparing the records from this field against actual company records.

  • company_id - Passes through a singleton company based on the current user, and the allowed companies for the record.

Hooks

A generic post_init_hook and uninstall_hook is provided, which will alter a pre-existing single-company security rule to be multi-company aware.

These hooks will unfortunately not work in every circumstance, but they cut out significant boilerplate when relevant.

import logging

_logger = logging.getLogger(__name__)

try:
    from odoo.addons.base_multi_company import hooks
except ImportError:
    _logger.info('Cannot find `base_multi_company` module in addons path.')


def post_init_hook(cr, registry):
    hooks.post_init_hook(
        cr,
        'product.product_comp_rule',
        'product.template',
    )


def uninstall_hook(cr, registry):
    hooks.uninstall_hook(
        cr,
        'product.product_comp_rule',
    )

A module implementing these hooks would need to first identify the proper rule for the record (product.product_comp_rule in the above example).

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

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

Credits

Authors

  • LasLabs

  • Tecnativa

Contributors

Maintainers

This module is maintained by the OCA.

Odoo Community Association

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.

Current maintainer:

pedrobaeza

This module is part of the OCA/multi-company project on GitHub.

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

File details

Details for the file odoo13_addon_base_multi_company-13.0.1.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for odoo13_addon_base_multi_company-13.0.1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 13f5c97c6d700fe538bca9cee8ecaa93e86c547e0c3b0ad82fa8896f3a79937c
MD5 65c463e8ca9a60463d63ab64ab731dc0
BLAKE2b-256 6ecd8c17a358dcfc875570b226ba2338478cd72394811d600b0c2b82753d77cc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page